contactually-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ad5e5f35bd6313dabb8c0d31f19c7f04148b35c
+  data.tar.gz: ebb1775b23927a2ff1949f8fb4ae63b4a48ff01b
+SHA512:
+  metadata.gz: 1fa545571fa44178ee7fbe365cf31b3f39f712d12a65e138cbb0042b141dd34e71a2aa48c177e7e1f1279c81bf0c1680bfce7613261656622ae7b80cf0832089
+  data.tar.gz: 838af6c311ab5ad8a4a7bf65f6771f2056ff1f1d86a4948848d4899b357e823dae688779657b5893b32eb581131b35762326934a7ca4cac2a982e0e2299765ce

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Revaluate
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Contactually-Ruby
+
+[![Code Climate](https://codeclimate.com/github/revaluate/contactually-ruby/badges/gpa.svg)](https://codeclimate.com/github/revaluate/contactually-ruby)
+[![Build
+Status](https://travis-ci.org/revaluate/contactually-ruby.svg?branch=master)](https://travis-ci.org/revaluate/contactually-ruby)
+
+This is a simple API Wrapper for the Contactually API. It is not feature complete, as it does not support all available API endpoints yet, but should work for most use cases this will be fine. Feel free to contribute!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contactually-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contactually-ruby
+
+## Usage
+
+### Configuration
+
+As `contactually-ruby` is shipped with sensible defaults, that will allow you
+to start right away, there are a couple of settings you may want to adjust,
+depending on your applications requirements.
+
+The available configuration options are:
+
+* access_token (your contactually access_token)
+* contactually_url (Default: "https://api.contactually.com/v2/")
+
+Configuration goes as follows:
+
+```ruby
+    Contactually.configure do |c|
+      c.api_token         = "TOKEN FROM OAUTH"
+      c.contactually_url  = "URL"
+    end
+```
+
+#### How to use the gem
+
+```ruby
+    contactually = Contactually::API.new
+    contacts = contactually.contacts.index
+    # => [#<Contactually::Contact id=1234, ...>, #<Contactually::Contact id=1235, ...>, ...]
+    notes = contactually.notes.index
+    # => [#<Contactually::Note id=2345, ...>, #<Contactually::Note id=2346, ...>, ...]
+    groupings = contactually.groupings.index
+    # => [#<Contactually::Grouping id=3456, ...>, #<Contactually::Grouping id=3457, ...>, ...]
+
+    contact = { contact: { first_name: 'Jane', last_name: 'Doe', ... } }
+    contactually.contacts.create(contact)
+    # => #<Contactually::Contact id=9876, first_name='Jane', last_name='Doe', ...>
+```
+
+Implemented endpoints are:
+
+* Accounts
+* Buckets
+* Contact Groupings
+* Contacts
+* Contents
+* Groupings
+* Notes
+* Tasks
+
+The API is documented here: [Contactually API Docs](http://developers.contactually.com/docs/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'rspec/core/rake_task'
+  desc 'Run all examples'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/lib/contactually-ruby.rb

@@ -0,0 +1,38 @@
+require 'active_support/configurable'
+require 'active_support/inflector'
+require 'faraday'
+require 'json'
+require 'roar/decorator'
+require 'roar/representer/json'
+
+require 'contactually/version'
+require 'contactually/errors'
+require 'contactually/utils'
+
+require 'contactually/middleware/error_detector'
+
+require 'contactually/representer/grouping_representer'
+require 'contactually/representer/account_representer'
+require 'contactually/representer/contact_representer'
+require 'contactually/representer/bucket_representer'
+require 'contactually/representer/content_representer'
+require 'contactually/representer/grouping_statistic_representer'
+require 'contactually/representer/note_representer'
+require 'contactually/representer/task_representer'
+
+require 'contactually/api'
+require 'contactually/groupings'
+require 'contactually/contacts'
+require 'contactually/buckets'
+require 'contactually/notes'
+require 'contactually/contact_groupings'
+require 'contactually/accounts'
+require 'contactually/contents'
+require 'contactually/tasks'
+
+module Contactually
+  include ActiveSupport::Configurable
+
+  config_accessor(:access_token)
+  config_accessor(:contactually_url) { "https://api.contactually.com/v2/" }
+end

data/lib/contactually/accounts.rb

@@ -0,0 +1,22 @@
+module Contactually
+  class Accounts
+
+    def initialize(master)
+      @master = master
+    end
+
+    def index(params = {})
+      hash = @master.call('accounts.json', :get, params)
+      Contactually::Utils.accounts_hash_to_objects(hash)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("accounts/#{id}.json", :get, params)
+      Contactually::Utils.build_account(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("accounts/#{id}.json", :delete, params)
+    end
+  end
+end

data/lib/contactually/api.rb

@@ -0,0 +1,87 @@
+module Contactually
+  class API
+    def initialize(access_token = nil)
+      raise ConfigMissingApiKeyError, 'You must provide a Contactually access_token' unless Contactually.config.access_token || access_token
+      @access_token = Contactually.config.access_token || access_token
+      @base_url = Contactually.config.contactually_url
+    end
+
+    def call(url, http_method, params={})
+      response = send(http_method, url, params)
+      JSON.load(response.body)
+    end
+
+    def contacts
+      @contacts ||= Contactually::Contacts.new self
+    end
+
+    def buckets
+      @buckets ||= Contactually::Buckets.new self
+    end
+
+    def notes
+      @notes ||= Contactually::Notes.new self
+    end
+
+    def tasks
+      @tasks ||= Contactually::Tasks.new self
+    end
+
+    def groupings
+      @groupings ||= Contactually::Groupings.new self
+    end
+
+    def accounts
+      @accounts ||= Contactually::Accounts.new self
+    end
+
+    def contact_groupings
+      @contact_groupings ||= Contactually::ContactGroupings.new self
+    end
+
+    def contents
+      @contents ||= Contactually::Contents.new self
+    end
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers['Authorization'] = "Bearer #{@access_token}"
+        faraday.adapter Faraday.default_adapter
+        faraday.use Contactually::Middleware::ErrorDetector
+      end
+    end
+
+  private
+
+    def call_params(params)
+      params.merge({ access_token: @access_token })
+    end
+
+    def post(url, params)
+      connection.post do |req|
+        req.url base_url(url)
+        req.body = call_params(params).to_json
+      end
+    end
+
+    def put(url, params)
+      connection.put do |req|
+        req.url base_url(url)
+        req.body = call_params(params).to_json
+      end
+    end
+
+    def get(url, params)
+      connection.get(base_url(url), call_params(params))
+    end
+
+    def delete(url, params)
+      connection.delete(base_url(url), call_params(params))
+    end
+
+    def base_url(url)
+      "#{@base_url}#{url}"
+    end
+  end
+end

data/lib/contactually/buckets.rb

@@ -0,0 +1,49 @@
+module Contactually
+  class Buckets
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('buckets.json', :post, params)
+      Contactually::Utils.build_bucket(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("buckets/#{id}.json", :delete, {})
+    end
+
+    def destroy_multiple(params = {})
+      @master.call('buckets.json', :delete, params)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("buckets/#{id}.json", :get, params)
+      Contactually::Utils.build_bucket(hash)
+    end
+
+    def update(id, params = {})
+      hash = @master.call("buckets/#{id}.json", :put, params)
+      Contactually::Utils.build_bucket(hash);
+    end
+
+    def index(params = {})
+      hash = @master.call('buckets.json', :get, params)
+      Contactually::Utils.buckets_hash_to_objects(hash)
+    end
+
+    def contacts(id, params = {})
+      hash = @master.call("buckets/#{id}/contacts.json", :get, params)
+      Contactually::Utils.contacts_hash_to_objects(hash)
+    end
+
+    def search(params = {})
+      hash = @master.call('buckets/search.json', :get, params)
+      Contactually::Utils.buckets_hash_to_objects(hash)
+    end
+
+    def count(params = { limit: 1 })
+      @master.call('buckets.json', :get, params)["meta"]["total"]
+    end
+  end
+end

data/lib/contactually/contact_groupings.rb

@@ -0,0 +1,16 @@
+module Contactually
+  class ContactGroupings
+    def initialize(master)
+      @master = master
+    end
+
+    def create(id, params = {})
+      hash = @master.call("contacts/#{id}/groupings.json", :post, params)
+      Contactually::Utils.build_grouping(hash)
+    end
+
+    def destroy(id, grouping_id, params = {})
+      @master.call("contacts/#{id}/groupings/#{grouping_id}.json", :delete, params)
+    end
+  end
+end

data/lib/contactually/contacts.rb

@@ -0,0 +1,54 @@
+module Contactually
+  class Contacts
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('contacts.json', :post, params)
+      Contactually::Utils.build_contact(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("contacts/#{id}.json", :delete, {})
+    end
+
+    def destroy_multiple(params = {})
+      @master.call('contacts.json', :delete, params)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("contacts/#{id}.json", :get, params)
+      Contactually::Utils.build_contact(hash)
+    end
+
+    def merge(params = {})
+      hash = @master.call('contacts/merge.json', :post, params)
+      Contactually::Utils.build_contact(hash)
+    end
+
+    def tags(id, params = {})
+      params[:tags] = params[:tags].join(', ') if params[:tags].class == Array
+      @master.call("contacts/#{id}/tags.json", :post, params)
+    end
+
+    def update(id, params = {})
+      hash = @master.call("contacts/#{id}.json", :put, params)
+      Contactually::Utils.build_contact(hash);
+    end
+
+    def index(params = {})
+      hash = @master.call('contacts.json', :get, params)
+      Contactually::Utils.contacts_hash_to_objects(hash)
+    end
+
+    def search(params = {})
+      hash = @master.call('contacts/search.json', :get, params)
+      Contactually::Utils.contacts_hash_to_objects(hash)
+    end
+
+    def count(params = { limit: 1 })
+      @master.call('contacts.json', :get, params)["total_count"]
+    end
+  end
+end

data/lib/contactually/contents.rb

@@ -0,0 +1,30 @@
+module Contactually
+  class Contents
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('contents.json', :post, params)
+      Contactually::Utils.build_content(hash)
+    end
+
+    def index(params = {})
+      hash = @master.call('contents.json', :get, params)
+      Contactually::Utils.contents_hash_to_objects(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("contents/#{id}.json", :delete, params)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("contents/#{id}.json", :get, params)
+      Contactually::Utils.build_content(hash)
+    end
+
+    def update(id, params = {})
+      @master.call("contents/#{id}.json", :put, params)
+    end
+  end
+end

data/lib/contactually/errors.rb

@@ -0,0 +1,21 @@
+module Contactually
+
+  class Error < StandardError
+  end
+
+  class ConfigMissingApiKeyError < Error
+  end
+
+  class InvalidParametersError < Error
+  end
+
+  class DuplicatedContactError < Error
+  end
+
+  class AuthenticationError < Error
+  end
+
+  class APIError < Error
+  end
+
+end