contactually-rb 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58550cd0b125395d4d4eef82969926341df54910
-  data.tar.gz: 4c1882fa6d550722397ce0d8765699ed87a5f52c
+  metadata.gz: 6ca86ed4a44105737365ae712c44cd516ca6239e
+  data.tar.gz: 2ba957b4f8e90c16ac3a35affdee95d5cc728eed
 SHA512:
-  metadata.gz: 840051269ffe887d36ebad07f2d9f2d3d90c791b4eba8d9befb8614aeab2c27c474aa180efd7c02ff4778049964719f5cd78dbec754d6f59dbad04545d4dcd3f
-  data.tar.gz: ea607a7ec81d15733eb11cfeb581f180bf67ad177f39f58f26e6a9994a238825a588e3768828f16483c5d7a610b265dc16d93f050f46af861e59aa665e5391d8
+  metadata.gz: 9c6e12acce324a5a1c27c24294ced9e5dd44ee2cf85107df1cbfb7f3f35167b08ebfafa8c48beb2a92d75e35aa1465871e5c7241cf7a270171c3c492d6b966cc
+  data.tar.gz: b9818e01a7c379f8c32b9e25b901daac99b453232019a941f8f181b4a327dd2e83de57010282a6956f97500d049b7d5ebdfe8cdf7c3543156c0e198c71458971

data/.travis.yml

@@ -4,3 +4,7 @@ rvm:
   - 2.3.1
 env: CODECLIMATE_REPO_TOKEN=9457072d7c7f1610175a27a9c1aa484dfc680e6b66cabc4dea96dba7658aa93c
 before_install: gem install bundler -v 1.12.5
+notifications:
+  slack:
+    rooms:
+      - realscout:fuqLTtjaXVdGsbtQWrnRbK0G#tech-notifications

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    contactually-rb (0.1.1)
+    contactually-rb (0.1.2)
       faraday (~> 0.9.2)
       faraday_middleware (~> 0.10.0)
 
@@ -61,10 +61,10 @@ DEPENDENCIES
   bundler (~> 1.12)
   codeclimate-test-reporter (~> 0.6.0)
   contactually-rb!
-  pry
+  pry (~> 0.10)
   rake (~> 10.0)
   rspec (~> 3.0)
-  webmock
+  webmock (~> 2.1)
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -24,7 +24,9 @@ gem install contactually-rb
 
 ## Usage
 
-Simple list contacts example,
+### Simple list contacts example
+
+Create a client instance
 
 ```ruby
 require 'contactually'
@@ -32,45 +34,60 @@ require 'contactually'
 client = Contactually::Client.new(auth_token: '<auth_token>')
 #   or
 client = Contactually::Client.new(api_key: '<api_key>')
+```
+
+```ruby
+# List contacts
+contacts = client.contacts.list
+# => #<Contactually::Collection>
 
-response = client.contacts.list
+# Access to response wrapper
+client.contacts.response
 # => #<Contactually::Response>
 
-response.data
-# => #<Contactually::Collection>
+# Raw farday response
+client.contacts.response.raw_response
+# => #<Faraday::Response>
 
-response.data.total # => 73
-response.raw_response # => #<Faraday::Response>
+contacts.total # => 73 Total contact count
+contacts.size # => 50 Total contacts in current list
 
-data = response.data
-contact = data.first # => #<Contactually::Models::Contact>
+contact = contacts.first # => #<Contactually::Models::Contact>
 contact.first_name # => "Nic"
-
 ```
 
-Loop through all contacts (it will yield contact and transparently loop through all contacts in batches of 50 using Contacutally pagination),
+Looping through all contacts (it will yield contact and transparently loop through all contacts in batches of 50 using Contacutally pagination),
 
 ```ruby
 client = Contactually::Client.new(auth_token: '<auth_token>')
 
 client.contacts.list_each do |contact|
-  # do something with contact
+  # do something with contact, 50 per batch as specified by Contactually API
 end
 ```
 
+### Searching
+
+```ruby
+collection = client.contacts.list({q: 'Nic'})
+collection.first.name # => Nic
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contactually-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RealScout/contactually-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Todos
 
-- Support update endpoints
+- ~~Support update endpoints~~
 - Support Contact convenience endpoints (eg: /contacts/:id/notes)
-- Support Create, Destroy endpoints
+- ~~Support Create, Destroy endpoints~~
 - Support other endpoints
+- Better client testing support (`Contactually.configuration.test_mode = true`)
+- Documentation

data/contactually-api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nick Blumenthal", "Nic Cavigliano"]
   spec.email         = ["nick@realscout.com", "ncavig@gmail.com"]
 
-  spec.summary       = ''
+  spec.summary       = 'Simple wrapper around Contactually v2 API'
   spec.description   = ''
   spec.homepage      = "https://github.com/RealScout/contactually-api"
 
@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.6.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 2.1"
 end

data/lib/contactually.rb

@@ -42,8 +42,14 @@ module Contactually
   class NotFoundError < Error
   end
 
+  class PaymentRequiredError < Error
+  end
+
   class UnauthorizedError < Error
   end
+
+  class TypeMismatchError < Error
+  end
 end
 
 require 'contactually/models/model'
@@ -52,11 +58,13 @@ require 'contactually/middleware/error_middleware'
 require 'contactually/models/address'
 require 'contactually/models/bucket'
 require 'contactually/models/email_address'
+require 'contactually/models/participant'
 require 'contactually/models/phone_number'
 require 'contactually/models/social_media_profile'
 require 'contactually/models/tag'
 require 'contactually/models/website'
 require 'contactually/models/contact'
+require 'contactually/models/interaction'
 require 'contactually/models/task'
 require 'contactually/models/user'
 
@@ -65,6 +73,7 @@ require 'contactually/base'
 require 'contactually/buckets'
 require 'contactually/collection'
 require 'contactually/contacts'
+require 'contactually/interactions'
 require 'contactually/interface'
 require 'contactually/me'
 require 'contactually/response'

data/lib/contactually/base.rb

@@ -34,8 +34,9 @@ module Contactually
       end
     end
 
-    def create
+    def create(body)
       check_implementation(:create)
+      Response.new(interface.post(build_fetch_url, body), self)
     end
 
     def fetch(id, params = {})
@@ -43,12 +44,14 @@ module Contactually
       Response.new(interface.get(build_fetch_url(id), params), self)
     end
 
-    def update
+    def update(id, body)
       check_implementation(:update)
+      Response.new(interface.patch(build_fetch_url(id), body), self)
     end
 
-    def delete
-      check_implementation(:delete)
+    def destroy(id)
+      check_implementation(:destroy)
+      interface.destroy(build_fetch_url(id))
     end
 
     def check_implementation(method)

data/lib/contactually/buckets.rb

@@ -1,6 +1,6 @@
 module Contactually
   class Buckets < Base
-    implements :list, :fetch
+    implements :create, :fetch, :list, :update, :destroy
 
     def initialize(url: '/v2/buckets', interface: nil)
       @url = url

data/lib/contactually/client.rb

@@ -21,8 +21,12 @@ module Contactually
       @contacts ||= Contactually::Contacts.new(interface: interface)
     end
 
+    def interactions
+      @interactions ||= Contactually::Interactions.new(interface: interface)
+    end
+
     def me
-      @contacts ||= Contactually::Me.new(interface: interface)
+      @me ||= Contactually::Me.new(interface: interface)
     end
 
     def tags

data/lib/contactually/contacts.rb

@@ -1,6 +1,6 @@
 module Contactually
   class Contacts < Base
-    implements :list, :fetch
+    implements :create, :list, :fetch, :update, :destroy
 
     def initialize(url: '/v2/contacts', interface: nil)
       @url = url

data/lib/contactually/interactions.rb

@@ -0,0 +1,14 @@
+module Contactually
+  class Interactions < Base
+    implements :create, :fetch, :update, :destroy
+
+    def initialize(url: '/v2/interactions', interface: nil)
+      @url = url
+      @interface = interface
+    end
+
+    def model
+      Models::Interaction
+    end
+  end
+end

data/lib/contactually/interface.rb

@@ -7,22 +7,35 @@ module Contactually
       @api_key = api_key
       @adapter = Contactually.configuration.adapter || :net_http
       @base_url = base_url
-
-      set_headers
     end
 
     def get(url, params)
       connection.get(build_full_url(url), params)
     end
 
+    def patch(url, body)
+      connection.patch(build_full_url(url), body)
+    end
+
+    def post(url, body)
+      connection.post(build_full_url(url), body)
+    end
+
+    def destroy(url)
+      connection.delete(build_full_url(url))
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
-        conn.adapter  @adapter
+        conn.request :json
+
         conn.response :json, :content_type => /\bjson$/
         conn.use Contactually::Middleware::ErrorHandler
 
-        conn.headers['Content-type']  = 'application/json',
         conn.headers['Authorization'] = "Bearer #{token}"
+        conn.headers['Content-type']  = 'application/json'
+
+        conn.adapter  @adapter
       end
     end
 
@@ -39,12 +52,5 @@ module Contactually
     def token
       auth_token || api_key
     end
-
-    def set_headers
-      @headers = {
-        'Content-type' => 'application/json',
-        'Authorization' => "Bearer #{token}"
-      }
-    end
   end
 end

data/lib/contactually/me.rb

@@ -1,6 +1,6 @@
 module Contactually
   class Me < Base
-    implements :fetch
+    implements :fetch, :update
 
     def initialize(url: '/v2/me', interface: nil)
       @url = url
@@ -11,6 +11,10 @@ module Contactually
       super(nil)
     end
 
+    def update(body)
+      super(nil, body)
+    end
+
     def model
       Models::User
     end

data/lib/contactually/middleware/error_middleware.rb

@@ -7,6 +7,9 @@ module Contactually
             when 401
               # Missing or invalid auth token
               raise Contactually::UnauthorizedError.new(error_messages(env.response))
+            when 402
+              # Auth token could be invalid due to non-payment
+              raise Contactually::PaymentRequiredError.new(error_messages(env.response))
             when 403
               # App does not have permission to perform the operation
               raise Contactually::ForbiddenError.new(error_messages(env.response))
@@ -25,7 +28,13 @@ module Contactually
         body = parse_body(response)
 
         if body.has_key?('errors')
-          body['errors']
+          case body['errors']
+            when Array
+              body['errors']
+            else
+              # Sometimes Contactually returns an errors key with a nested object instead of a list of errors
+              [body['errors'].to_s]
+          end
         else
           generic_error
         end

data/lib/contactually/models/interaction.rb

@@ -0,0 +1,19 @@
+module Contactually
+  module Models
+    class Interaction
+      include Model
+
+      field :created_at, :datetime
+      field :body, :string
+      field :id, :string
+      field :initiated_by_contact, :boolean
+      field :participants, [Participant]
+      field :subject, :string
+      field :type, :string
+
+      # field :custom_fields, [String] TODO: should be it's own model type
+      field :extra_data, Hash
+
+    end
+  end
+end

data/lib/contactually/models/model.rb

@@ -41,6 +41,12 @@ module Contactually
           when :integer then value.to_i
           when :float then value.to_f
           when :date then value.to_date
+          when :boolean
+            if !!value == value
+              value
+            else
+              raise Contactually::TypeMismatchError.new(["Expected a boolean but got #{value.class}"])
+            end
           when :datetime then DateTime.parse(value)
           else
             case type

data/lib/contactually/models/participant.rb

@@ -0,0 +1,10 @@
+module Contactually
+  module Models
+    class Participant
+      include Model
+
+      field :contact_id, :string
+      field :handle, :string
+    end
+  end
+end

data/lib/contactually/tasks.rb

@@ -1,6 +1,6 @@
 module Contactually
   class Tasks < Base
-    implements :list, :fetch
+    implements :create, :fetch, :update, :destroy
 
     def initialize(url: '/v2/tasks', interface: nil)
       @url = url

data/lib/contactually/version.rb

@@ -1,3 +1,3 @@
 module Contactually
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contactually-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Blumenthal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,30 +99,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: ''
 email:
 - nick@realscout.com
@@ -151,6 +151,7 @@ files:
 - lib/contactually/client.rb
 - lib/contactually/collection.rb
 - lib/contactually/contacts.rb
+- lib/contactually/interactions.rb
 - lib/contactually/interface.rb
 - lib/contactually/me.rb
 - lib/contactually/middleware/error_middleware.rb
@@ -158,7 +159,9 @@ files:
 - lib/contactually/models/bucket.rb
 - lib/contactually/models/contact.rb
 - lib/contactually/models/email_address.rb
+- lib/contactually/models/interaction.rb
 - lib/contactually/models/model.rb
+- lib/contactually/models/participant.rb
 - lib/contactually/models/phone_number.rb
 - lib/contactually/models/social_media_profile.rb
 - lib/contactually/models/tag.rb
@@ -192,6 +195,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Simple wrapper around Contactually v2 API
 test_files: []
-has_rdoc: