Merge fad9205 into f7222b2

lib/capsule_crm.rb

@@ -10,6 +10,7 @@
 require 'capsule_crm/email'
 require 'capsule_crm/party'
 require 'capsule_crm/phone'
+require 'capsule_crm/user'
 require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'
 require 'capsule_crm/results_proxy'

lib/capsule_crm/user.rb

@@ -0,0 +1,34 @@
+module CapsuleCRM
+  class User
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include CapsuleCRM::Associations::BelongsTo
+
+    attribute :username, String
+    attribute :name, String
+    attribute :currency, String
+    attribute :timezone, String
+    attribute :logged_in, Boolean
+
+    belongs_to :party, class_name: 'CapsuleCRM::Party'
+
+    # Public: Retrieve all users from CapsuleCRM
+    #
+    # Examples:
+    #
+    # CapsuleCRM::User.all
+    #
+    # Returns a CapsuleCRM::ResultsProxy of CapsuleCRM::User objects
+    def self.all
+      CapsuleCRM::ResultsProxy.new(
+        CapsuleCRM::Connection.get('/api/users')['users']['user'].map do |item|
+          new item
+        end
+      )
+    end
+  end
+end

spec/lib/capsule_crm/user_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe CapsuleCRM::User do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/users$/).
+        to_return(body: File.read('spec/support/all_users.json'))
+    end
+
+    subject { CapsuleCRM::User.all }
+
+    it { should be_a(Array) }
+
+    it { subject.length.should eql(2) }
+
+    it { subject.all? { |item| item.is_a?(CapsuleCRM::User) }.should be_true }
+  end
+end

spec/support/all_users.json

@@ -0,0 +1,21 @@
+{
+  "users": {
+    "user": [
+      {
+        "username": "a.user",
+        "currency": "GBP",
+        "name": "Alfred User",
+        "loggedIn": "true",
+        "timezone": "Europe/London",
+        "partyId": "100"
+      },
+      {
+        "username": "j.joe",
+        "currency": "GBP",
+        "name": "Jane Doe",
+        "timezone": "Europe/London",
+        "partyId": "101"
+      }
+    ]
+  }
+}