contactually-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 749467e599e692c5cc21a49444d12055f0ca31b7
+  data.tar.gz: 492eb3805a030a9921e75d4b8284388675f37817
+SHA512:
+  metadata.gz: 6042bbafb8b6c2df1747d3c6685795d1d90fa1823287cbda53bf436dc193d03649d308235674c2d37bf493554927c5d17539b35bb02196624494608376206a47
+  data.tar.gz: 9f182641b3031f9f08f2b6fb1e2160aaf346e44b0f704a3c7b5405ae05ad9a53ef0e28b788b7ed1a3f5028ed622a01db091b55eed0f4fe465dbce18d03ea6d7a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johannes Heck
+
+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,62 @@
+# Contactually-API
+
+[![Build
+Status](https://travis-ci.org/railslove/contactually-api.svg?branch=master)](https://travis-ci.org/railslove/contactually-api)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contactually-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contactually-api
+
+## Usage
+
+### Configuration
+
+As `contactually-api` 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:
+
+* api_key (your contactually api_key)
+* contactually_url (Default: "https://www.contactually.com/api/v1/")
+
+Configuration goes as follows:
+
+    Contactually.configure do |c|
+      c.api_key           = "YOURKEY"
+      c.contactually_url  = "URL"
+    end
+
+#### How to use the gem
+
+    contactually = Contactually::API.new
+    contacts = contactually.contacts.index
+    notes = contactually.notes.index
+    groupings = contactually.groupings.index
+
+    contact = { contact: { first_name: 'Jane', last_name: 'Doe', ... } }
+    contactually.contacts.create(contact)
+
+    ...
+
+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-api.rb

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

data/lib/contactually/accounts.rb

@@ -0,0 +1,31 @@
+module Contactually
+  class Accounts
+
+    def initialize(master)
+      @master = master
+    end
+
+    def index(params = {})
+      hash = @master.call('accounts.json', :get, params)
+      accounts_hash_to_objects(hash)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("accounts/#{id}.json", :get, params)
+      AccountRepresenter.new(Account.new).from_hash(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("accounts/#{id}.json", :delete, params)
+    end
+
+    private
+
+    def accounts_hash_to_objects(hash)
+      hash['accounts'].inject([]) do |arr, account|
+        arr << AccountRepresenter.new(Account.new).from_hash(account)
+      end
+    end
+
+  end
+end

data/lib/contactually/api.rb

@@ -0,0 +1,70 @@
+module Contactually
+  class API
+    def initialize
+      raise ConfigMissingApiKeyError, 'You must provide a Contactually API key' unless Contactually.config.api_key
+      @api_key = Contactually.config.api_key
+      @base_url = Contactually.config.contactually_url
+    end
+
+    def call(url, method, params={})
+      response = send(method, url, params)
+      JSON.load(response.body)
+    end
+
+    def contacts
+      Contactually::Contacts.new self
+    end
+
+    def notes
+      Contactually::Notes.new self
+    end
+
+    def groupings
+      Contactually::Groupings.new self
+    end
+
+    def accounts
+      Contactually::Accounts.new self
+    end
+
+    def contact_groupings
+      Contactually::ContactGroupings.new self
+    end
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.adapter  Faraday.default_adapter
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.use Contactually::Middleware::ErrorDetector
+      end
+    end
+
+    private
+
+    def call_params(params)
+      params.merge({ api_key: @api_key })
+    end
+
+    [ :post, :put ].each do |method_name|
+      define_method(method_name) do |url, params|
+        response = connection.send(method_name) do |req|
+          req.url base_url(url)
+          req.body = call_params(params).to_json
+        end
+        response
+      end
+    end
+
+    [ :get, :delete ].each do |method_name|
+      define_method(method_name) do |url, params|
+        response = connection.send(method_name, base_url(url), call_params(params))
+        response
+      end
+    end
+
+    def base_url(url)
+      "#{@base_url}#{url}"
+    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)
+      GroupingRepresenter.new(Grouping.new).from_hash(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,57 @@
+module Contactually
+  class Contacts
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('contacts.json', :post, params)
+      ContactRepresenter.new(Contact.new).from_hash(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)
+      ContactRepresenter.new(Contact.new).from_hash(hash)
+    end
+
+    def merge(params = {})
+      hash = @master.call('contacts/merge.json', :post, params)
+      ContactRepresenter.new(Contact.new).from_hash(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 = {})
+      @master.call("contacts/#{id}.json", :put, params)
+    end
+
+    def index(params = {})
+      hash = @master.call('contacts.json', :get, params)
+      contacts_hash_to_objects(hash)
+    end
+
+    def search(params = {})
+      hash = @master.call('contacts/search.json', :get, params)
+      contacts_hash_to_objects(hash)
+    end
+
+    private
+
+    def contacts_hash_to_objects(hash)
+      hash['contacts'].inject([]) do |arr, contact|
+        arr << ContactRepresenter.new(Contact.new).from_hash(contact)
+      end
+    end
+  end
+end

data/lib/contactually/contents.rb

@@ -0,0 +1,38 @@
+module Contactually
+  class Contents
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('contents.json', :post, params)
+      ContentRepresenter.new(Content.new).from_hash(hash)
+    end
+
+    def index(params = {})
+      hash = @master.call('contents.json', :get, params)
+      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)
+      ContentRepresenter.new(Content.new).from_hash(hash)
+    end
+
+    def update(id, params = {})
+      @master.call("contents/#{id}.json", :put, params)
+    end
+
+    private
+
+    def contents_hash_to_objects(hash)
+      hash['contents'].inject([]) do |arr, content|
+        arr << ContentRepresenter.new(Content.new).from_hash(content)
+      end
+    end
+  end
+end

data/lib/contactually/errors.rb

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

data/lib/contactually/groupings.rb

@@ -0,0 +1,49 @@
+module Contactually
+  class Groupings
+    def initialize(master)
+      @master = master
+    end
+
+    def create(params = {})
+      hash = @master.call('groupings.json', :post, params)
+      GroupingRepresenter.new(Grouping.new).from_hash(hash)
+    end
+
+    def index(params = {})
+      hash = @master.call('groupings.json', :get, params)
+      groupings_hash_to_objects(hash)
+    end
+
+    def minimal_index(params = {})
+      hash = @master.call('groupings/minimal_index.json', :get, params)
+      GroupingRepresenter.new(Grouping.new).from_hash(hash)
+    end
+
+    def destroy(id, params = {})
+      @master.call("groupings/#{id}.json", :delete, params)
+    end
+
+    def show(id, params = {})
+      hash = @master.call("groupings/#{id}.json", :get, params)
+      GroupingRepresenter.new(Grouping.new).from_hash(hash)
+    end
+
+    def update(id, params = {})
+      hash = @master.call("groupings/#{id}.json", :put, params)
+      GroupingRepresenter.new(Grouping.new).from_hash(hash)
+    end
+
+    def statistics(id, params = {})
+      hash = @master.call("groupings/#{id}/statistics.json", :get, params)
+      GroupingStatisticsRepresenter.new(GroupingStatistics.new).from_hash(hash)
+    end
+
+    private
+
+    def groupings_hash_to_objects(hash)
+      hash['groupings'].inject([]) do |arr, grouping|
+        arr << GroupingRepresenter.new(Grouping.new).from_hash(grouping)
+      end
+    end
+  end
+end

data/lib/contactually/middleware/error_detector.rb

@@ -0,0 +1,27 @@
+module Contactually
+  module Middleware
+    class ErrorDetector < Faraday::Middleware
+
+      def call(env)
+        @app.call(env).on_complete do
+          unless (200..299).include? env[:status]
+            cast_error(env[:body])
+          end
+        end
+      end
+
+      private
+
+      def cast_error(body)
+        case JSON.parse(body)['error']
+        when /^Invalid parameters/ then
+          raise InvalidParametersError, body
+        when /^We already have/ then
+          raise DuplicatedContactError, body
+        else
+          raise APIError, body
+        end
+      end
+    end
+  end
+end