nimble-api 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd7b880d49fe9c8e605358cdea4fb5c61621ec89
-  data.tar.gz: 65245f911f34dd7bc7273ca3e75c99d02d2f8cd5
+  metadata.gz: fb4a1b6010b3d5abb6ecbcfac6d900abbe61bc39
+  data.tar.gz: 8f5bdc7cb2f8543b59a822221eb1b42861df1945
 SHA512:
-  metadata.gz: 058cc21fb0085e9af501265ee63f2b88d8342e7ee6b0d5bd7a48734f0a84a54336d3507fad38c8c8d75993b90b62d1a5e7fa1b8cfc1b7eb0550da0f706f1f098
-  data.tar.gz: efe7defa1ab729c55f856667652795b2ed8716dde0874729b8f1a1f381cee1544106e2dc8f2976f5ce9b1c11558ec77e732497c989a738d8b92f91d77e02a50e
+  metadata.gz: 10a098e868490ba7fdabc74371ff229b374500a4cc76c4fe857a24c50ef42352c8e9429ff4557cb1e550eb8e0976def6584f0d61d80acf3984ff5076a9173488
+  data.tar.gz: fe718853e8cb0cdf0108b7364090ff91d247e6e5f9a45e65e74b9ca4a5095795a0edfb08aa1527f24a7327aad7feb737b4a245044ad639f73aad66a892c5863a

data/README.md

@@ -12,7 +12,7 @@ References:
 
 The nimble api uses oauth for authorization. As such, you are required to obtain a client secret, token and registered callback url for each domain (including your localhost for testing) before starting to use this wrapper. Once you have obtained these keys, you will need to generate a refresh token. This allows you to access the API without needing to do the oauth dance to recreate your api client each time.
 
-To use this wrapper, configure the NimbleApiApi with the following:
+To use this wrapper, configure the NimbleApi with the following:
 
     NimbleApi.configure do |c|
       c.client_id = ENV['CLIENT_ID']
@@ -24,11 +24,13 @@ If you plan to use this with rails, create config/initializers/nimble.rb with th
 
 ## Usage
 
+    > require 'nimble-api'
+
     # Configure with your id, secret and refresh token for your application
     NimbleApi.configure do |c|
-      c.client_id = ENV['CLIENT_ID']
-      c.client_secret = ENV['CLIENT_SECRET']
-      c.refresh_token = ENV['REFRESH_TOKEN']
+      c.client_id = ENV['NIMBLE_CLIENT_ID']
+      c.client_secret = ENV['NIMBLE_CLIENT_SECRET']
+      c.refresh_token = ENV['NIMBLE_REFRESH_TOKEN']
     end
 
     # Create a nimble object
@@ -47,6 +49,10 @@ If you plan to use this with rails, create config/initializers/nimble.rb with th
 
     fred.save
 
+    # Attempt to save duplicate person throws error - checking is based on first email value
+    > fred.save
+    RuntimeError: fred@bedrock.org already exists!
+
     # Update one element, or multiple
     fred.update("parent company" => [{ "modifier"=>"","value"=>"Cogswell Cogs"}])
 
@@ -80,11 +86,14 @@ If you plan to use this with rails, create config/initializers/nimble.rb with th
     > @nimble.contacts.list
     => {"meta"=>{"per_page"=>30, "total"=>238, "pages"=>8, "page"=>1}, "resources"=>[...]
 
-    >@nimble.contacts.list(fields: ['first name', 'last name', 'email'])
+    > @nimble.contacts.list(fields: ['first name', 'last name', 'email'])
     => ... limited to just these fields
 
-    >@nimble.contacts.list(keyword: 'fred')
+    > @nimble.contacts.list(keyword: 'fred')
     => {"meta"=>{"per_page"=>30, "total"=>1, "pages"=>1, "page"=>1}, "resources"=>[ ... just one ... ]
+    
+    > @nimble.contacts.list_ids( per_page:100, page: 2 )
+    => {"meta"=>{"per_page"=>100, "total"=>396, "pages"=>4, "page"=>2}, "resources"=>[ ... 100 resources ... ]
 
 ## Contacts
 

data/lib/nimble/contact.rb

@@ -58,6 +58,7 @@ module NimbleApi
       self
     end
 
+    # Searches contacts for matching email, sets self.contact to matching result
     def by_email email
       query = { "and" => [{ "email" => { "is"=> email } },{ "record type"=> { "is"=> "person" }} ] }
       resp = @nimble.get 'contacts', { :query => query.to_json }
@@ -66,6 +67,7 @@ module NimbleApi
       self
     end
 
+    # Gets contact by id and sets self.contact to result
     def fetch id=nil
       id ||= self.id
       resp = @nimble.get "contact/#{id}"
@@ -75,16 +77,19 @@ module NimbleApi
     end
     alias_method :get, :fetch
 
+    # Update with param 'fields' set to passed in param hash
     def update fields
       self.contact = @nimble.put "contact/#{self.id}", { fields: fields }
       return nil unless self.contact
       self
     end
 
+    # Returns notes for contact, based on params if provided
     def notes params=nil
       @nimble.get "contact/#{self.id}/notes", params
     end
 
+    # Adds note to contact. Preview set to 64 chars substring or can be provided
     def note note, preview=nil
       preview ||= note[0..64]
       params = {
@@ -95,15 +100,19 @@ module NimbleApi
       @nimble.post "contacts/notes", params
     end
 
+    # Delete not by id for self.contact
     def delete_note id
       @nimble.delete "contact/notes/#{id}"
     end
 
+    # Delete contact with id of self.contact, or by id as argument
     def delete id=nil
       id ||= self.id
       @nimble.delete "contact/#{id}"
     end
 
+    # Create new task for contac. due_date argument is parsed by Chronic and can be of
+    # format 'next week', 'tomorrow', 'Friday', 'Oct 10, 2014', etc.
     def task due_date, subject, notes=nil
       due = Chronic.parse(due_date).strftime('%Y-%m-%d %H:%M')
       params = {

data/lib/nimble/contacts.rb

@@ -6,12 +6,14 @@ module NimbleApi
       @nimble = nimble
     end
 
+    # Returns list of contacts. Limits contacts and fields with params if provided
     def list params={}
       params[:fields] = params[:fields].join(',') if params[:fields]
       params[:record_type] ||= 'person'
       @nimble.get "contacts", params
     end
 
+    # Returns list of contacts ids only. Limits contacts with params if provided
     def list_ids params={}
       @nimble.get "contacts/ids", params
     end

data/lib/nimble/version.rb

@@ -1,5 +1,5 @@
 module NimbleApi
 
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 
 end

data/nimble_api.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "rake", "~> 10.1"
 
-  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday", "~> 0.8"
   spec.add_dependency "chronic", "~> 0.10"
   spec.add_dependency "json", "~> 1.7"
 

data/spec/integration/contacts_spec.rb

@@ -9,6 +9,18 @@ describe NimbleApi::Contacts do
       c.refresh_token = REFRESH_TOKEN
     end
     @nimble = NimbleApi()
+    @fred = @nimble.contact.by_email 'fred@bedrock.org'
+    unless @fred
+      @person = {
+        'first name' => 'Fred',
+        'last name' => 'Flintstone',
+        'email' => 'fred@bedrock.org',
+        'tags' => 'test'
+      }
+      @fred = @nimble.contact.create @person
+      @fred.save
+    end
+
   end
 
   describe "list" do
@@ -33,8 +45,8 @@ describe NimbleApi::Contacts do
     end
 
     it "supports keyword param" do
-      resp = @nimble.contacts.list(keyword: 'winnie')
-      resp['resources'][0]['fields']['first name'][0]['value'].should eq 'winnie'
+      resp = @nimble.contacts.list(keyword: 'Fred')
+      resp['resources'][0]['fields']['first name'][0]['value'].should eq 'Fred'
     end
   end
 

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'bundler/setup'
 Bundler.setup(:development)
 
 require "rspec"
-require "nimble"
+require "nimble-api"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nimble-api
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Brian Wilkerson
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - lib/nimble/contact.rb
 - lib/nimble/contacts.rb
 - lib/nimble/version.rb
+- nimble-api-0.1.gem
 - nimble_api.gemspec
 - spec/integration/contact_spec.rb
 - spec/integration/contacts_spec.rb
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Nimble CRM Api Wrapper