capsule_crm 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1edcdd8d69a89209c63296cadd8ce24ca016d61
-  data.tar.gz: c8ea9420994ff54c71967c48feac9ad63087065d
+  metadata.gz: f4b9fd67a190082bdfaee77004d8b1a955292f6e
+  data.tar.gz: 0194fb59ce8ae5227ecbdf97db8b69384ae810b1
 SHA512:
-  metadata.gz: 7e8ef70a7bbc1a6fc40ae099617b4924eddc1dd5075ed30ede8fdb4a14ca5cb1e29e50114619dd02db62238ca59d4b40ba50da613a90c2dabdfcedfc68a987da
-  data.tar.gz: 8c0a324a128c47f696d8f46ce1c124994bd3c5bdae9ed3722b43d74f6b76dcff500b4b3dc8479439670c6c362e0cff152a1f460c41c791a46c7fe02779ee2d6a
+  metadata.gz: db99f83850c54977fea4732871099fc1f1fc5e31f01c8cefda62eb83f29d2f17e09147322e3ddd6f5489ad0435e2659aee1c3ffca06688b973f4aca64bb10b97
+  data.tar.gz: 316ac65226479c988cc5f0565ea9abbe5301a88b66c0f5e4d0c6dc22dccffd6daa97a85f8dcd63248623dda62c89b6d7239c6bd7400d44348f9a2897381afa4c

data/.hound.yml

@@ -0,0 +1,3 @@
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.6.0
+
+- ResponseError#to_s now return the response message from the server so errors
+  are a little easier to debug.
+
+## 1.5.3
+
+- A has many association will now accept a single object as an argument and
+  coerce that object into an array.
+
 ## 1.5.2
 
 - Fix issue with ruby 1.9.3 where incompatible OpenStruct syntax was being used.

data/README.md

@@ -10,6 +10,8 @@ Status](https://coveralls.io/repos/mattbeedle/capsule_crm/badge.png?branch=maste
 Status](https://gemnasium.com/mattbeedle/capsule_crm.png)](https://gemnasium.com/mattbeedle/capsule_crm)
 [![Stories in
 Ready](http://badge.waffle.io/mattbeedle/capsule_crm.png)](http://waffle.io/mattbeedle/capsule_crm)
+[![Gitter
+chat](https://badges.gitter.im/mattbeedle/capsule_crm.png)](https://gitter.im/mattbeedle/capsule_crm)
 
 # CapsuleCRM
 
@@ -157,6 +159,39 @@ history = org.histories.build note: 'some note text'
 history = org.histories.create note: 'some note text'
 ```
 
+### Contacts
+
+People and organizations may both have contacts. Contacts consist of emails,
+phones, websites and addresses.
+
+```ruby
+person.contacts
+# => CapsuleCRM::Contacts
+
+# Assign an array of CapsuleCRM::Email objects
+person.contacts.emails =
+  [CapsuleCRM::Email.new(email_address: 'test@test.com', type: 'Work')]
+
+# Assign an array of email attributes
+person.contacts.emails = [{ email_address: 'test@test.com', type: 'Work' }]
+
+# Add a new email
+person.contacts.emails << CapsuleCRM::Email.new(email_address: 'test@test.com')
+
+# person.emails delegates to person.contacts.emails so the above code may be
+# shortened to:
+
+person.emails =
+  [CapsuleCRM::Email.new(email_address: 'test@test.com', type: 'Work')]
+
+# Assign an array of email attributes
+person.emails = [{ email_address: 'test@test.com', type: 'Work' }]
+
+person.emails << CapsuleCRM::Email.new(email_address: 'test@test.com')
+
+# The above syntax is exactly the same for addresses, websites and phones.
+```
+
 ### Tracks
 ```ruby
 # List tracks
@@ -330,8 +365,14 @@ with fix.
 
 Many thanks to the following contributers:
 
-- @srbaker
-- @clod81
-- @danthompson
-- @ryanbooker
-- @ghiculescu
+- [@srbaker](https://github.com/srbaker)
+- [@clod81](https://github.com/clod81)
+- [@danthompson](https://github.com/danthompson)
+- [@ryanbooker](https://github.com/ryanbooker)
+- [@ghiculescu](https://github.com/ghiculescu)
+
+## Alternatives
+
+- [placebo](https://github.com/adrianpike/placebo)
+- [capsulecrm](https://github.com/ahmedrb/capsulecrm) - most active fork seems
+  to be [here](https://github.com/theodi/capsulecrm)

data/lib/capsule_crm/associations/has_many_association.rb

@@ -32,8 +32,9 @@ module CapsuleCRM
       #
       # parent      - The instance of the class that the has many assocation is
       # defined on
-      # collection  - An optional Array or Hash to use as the target for the
-      # proxy
+      # collection  - An optional Array, Hash or Object to use as the target for
+      # the proxy. An Object will be coerced into an Array, a Hash will be
+      # turned in to an Object and then coerced into an Array.
       #
       # Returns a CapsuleCRM::Associations::HasManyProxy
       def proxy(parent, collection = nil)

data/lib/capsule_crm/connection.rb

@@ -1,54 +1,66 @@
 module CapsuleCRM
   class Connection
-
-    # Public: Send a GET request to CapsuleCRM API
-    #
-    # path    - The String path where the request should go
-    # params  - The Hash of URL parameters
-    #
-    # Returns a Hash from the JSON response
     def self.get(path, params = {})
+      new.get(path, params)
+    end
+
+    def get(path, params)
       preprocess_params(params)
       JSON.parse request(:get, path, params).body
     end
 
     def self.post(path, params = {})
+      new.post(path, params)
+    end
+
+    def post(path, params)
       process_post_response request(:post, path, params.to_json)
     end
 
-    def self.put(path, params)
+    def self.put(path, params = {})
+      new.put(path, params)
+    end
+
+    def put(path, params)
       request(:put, path, params.to_json).success?
     end
 
     def self.delete(path)
-      request(:delete, path, {}).success?
+      new.delete(path)
+    end
+
+    def delete(path)
+      request(:delete, path).success?
     end
 
     private
 
-    def self.request(method, path, params)
-      CapsuleCRM.log "CapsuleCRM: #{method.upcase} #{path} with #{params}"
+    def request(method, path, params = {})
+      log "CapsuleCRM: #{method.upcase} #{path} with #{params}"
       faraday.send(method, path, params) do |req|
         req.headers.update default_request_headers
       end.tap do |response|
-        CapsuleCRM.log "CapsuleCRM Response: #{response.body}"
+        log "CapsuleCRM Response: #{response.body}"
       end
     end
 
-    def self.preprocess_params(params)
+    def log(string)
+      CapsuleCRM.log string
+    end
+
+    def preprocess_params(params)
       params.symbolize_keys!
       if params_contains_lastmodified(params)
         params[:lastmodified] = params[:lastmodified].strftime("%Y%m%dT%H%M%S")
       end
     end
 
-    def self.params_contains_lastmodified(params)
+    def params_contains_lastmodified(params)
       params.keys.include?(:lastmodified) &&
         params[:lastmodified].respond_to?(:strftime)
     end
 
-    # TODO clean this shit up
-    def self.process_post_response(response)
+    def process_post_response(response)
       if response.headers['Location'] &&
         match = response.headers['Location'].match(/\/(?<id>\d+)$/)
         { id: match[:id].to_i }
@@ -57,20 +69,24 @@ module CapsuleCRM
       end
     end
 
-    def self.default_request_headers
+    def default_request_headers
       { accept: 'application/json', content_type: 'application/json' }
     end
 
-    def self.faraday
-      ::Faraday.new("https://#{subdomain}.capsulecrm.com").tap do |connection|
+    def faraday
+      @faraday ||= ::Faraday.new("https://#{host}").tap do |connection|
         connection.basic_auth(CapsuleCRM.configuration.api_token, '')
         connection.request  :json
         connection.use CapsuleCRM::Faraday::Middleware::RaiseError
       end
     end
 
-    def self.subdomain
-      CapsuleCRM.configuration.subdomain
+    def host
+      @host ||= "#{subdomain}.capsulecrm.com"
+    end
+
+    def subdomain
+      @subdomain ||= CapsuleCRM.configuration.subdomain
     end
   end
 end

data/lib/capsule_crm/errors/response_error.rb

@@ -8,7 +8,17 @@ module CapsuleCRM
       end
 
       def to_s
-        JSON.parse(response.body)['message']
+        response_message || empty_message
+      end
+
+      private
+
+      def response_message
+        JSON.parse(response.body)['message'] if response
+      end
+
+      def empty_message
+        'capsulecrm.com returned an empty response'
       end
     end
   end

data/lib/capsule_crm/querying/find_all.rb

@@ -10,6 +10,10 @@ module CapsuleCRM
             get("/api/#{queryable_options.plural}", options)
           )
         end
+
+        def first
+          all(limit: 1).first
+        end
       end
     end
   end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '1.6.0'
+  VERSION = '1.6.1'
 end

data/spec/lib/capsule_crm/errors/response_error_spec.rb

@@ -1,17 +1,29 @@
 require 'spec_helper'
 
 describe CapsuleCRM::Errors::ResponseError do
+  let(:error) { CapsuleCRM::Errors::ResponseError.new(response) }
+
+  subject { error.to_s }
+
   describe '#to_s' do
-    let(:response) { double('Response', body: response_body.to_json) }
-    let(:response_body) do
-      { message: 'this is an error message from the server' }
+    context 'when the response is not nil' do
+      let(:response) { double('Response', body: response_body.to_json) }
+      let(:response_body) do
+        { message: 'this is an error message from the server' }
+      end
+      let(:error) { CapsuleCRM::Errors::ResponseError.new(response) }
+
+      it 'should include the server error message' do
+        expect(subject).to eql(response_body[:message])
+      end
     end
-    let(:error) { CapsuleCRM::Errors::ResponseError.new(response) }
 
-    subject { error.to_s }
+    context 'when the response is nil' do
+      let(:response) { nil }
 
-    it 'should include the server error message' do
-      expect(subject).to eql(response_body[:message])
+      it 'should return an empty response message' do
+        expect(subject).to eql('capsulecrm.com returned an empty response')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -242,6 +242,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md