agilecrm-wrapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 926e3d0e0645d675a68fdec939471f5e3693b2f6
+  data.tar.gz: e295958f5c71c25e047de65096a77ce2d1c0f128
+SHA512:
+  metadata.gz: 405466b4f3e9e937ef85c714da1615d1283ff213ad69bb471c2496082747f7509a5208eeeeb2ff3d7d4b1e4b0749119dd74ef53f5ffa15d63ad34b7a8216d353
+  data.tar.gz: 904226678f44055def597b3f0684e49500b7473367944cd577b1c30d587a00d144b44018bcc7bd3dfd862fdb47fcbf56851717f293fe9f38caeafd3f6961d7b7

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+todo.txt
+agile.js

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/Documentation:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agilecrm-ruby-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    agilecrm-wrapper (1.0.0)
+      faraday
+      faraday_middleware
+      hashie
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    awesome_print (1.2.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (3.3.1)
+    json (1.8.1)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    parser (2.2.0.pre.5)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.5)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.1)
+    rubocop (0.26.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.6.0)
+    safe_yaml (1.0.4)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    tilt (1.4.1)
+    webmock (1.19.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  agilecrm-wrapper!
+  awesome_print
+  bundler (~> 1.6)
+  pry
+  rake
+  rspec
+  rspec-its
+  rubocop
+  sinatra
+  webmock

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Cogmation Robotics Inc.
+
+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,119 @@
+AgileCRMWrapper
+=================
+
+This project is a ruby client that wraps the [AgileCRM REST API](https://www.agilecrm.com/api/rest). **Note: This is not an official project, you're welcome to use it but don't expect the AgileCRM team to support it.**
+
+At present, only operations related to the **contact** and **note** resources are supported. Need something added? Make a feature request in the issues tab. Pull requests are always welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'agilecrm-wrapper'
+
+And then execute:
+
+    $ bundle
+
+# Usage
+
+To begin using this gem, Initialize the library using a configuration block including your agile **API key**, **email**, and **domain**, like this:
+
+```ruby
+AgileCRMWrapper.configure do |config|
+  config.api_key = 'XXXXXXXXXXX'
+  config.domain = 'my-agile-domain'
+  config.email = 'myemail@example.com'
+end
+```
+
+### 1. Working with Contacts
+
+**GET** operations return one or more `AgileCRMWrapper::Contact` objects. These are just `Hashie::Mash` objects with a few utility methods sprinkled on. You can access any of the Contact fields returned by AgileCRM's REST API, see [here](https://www.agilecrm.com/api/rest#contact-fields) for what that entails. Example:
+```ruby
+contact = AgileCRMWrapper::Contact.find(123)
+contact.tags       #=> ["tag", "your", "it"]
+contact.id         #=> 123
+contact.properties #=> [{ type: 'SYSTEM', name: "email", value: "blah@mail.com" }]
+```
+
+###### To retrieve a list of contacts
+```ruby
+AgileCRMWrapper::Contact.all
+```
+
+###### To get an individual contact by ID
+```ruby
+AgileCRMWrapper::Contact.find(123)
+```
+
+###### To find contacts by email
+```ruby
+contact = AgileCRMWrapper::Contact.search_by_email("foo@example.com")
+# or pass multiple emails as seperate arguments or an array
+contacts = AgileCRMWrapper::Contact.search_by_email(
+"foo@example.com", "bar@example.com"
+)
+```
+
+###### To create a new contact
+```ruby
+AgileCRMWrapper::Contact.create(
+  tags: ["tag", "your", "it"],
+  first_name: "Justin",
+  last_name: "Case",
+  email: "blah@mail.com",
+  my_custom_field: "im a custom field!"
+)
+```
+
+###### To update a single contact
+```ruby
+contact.update(first_name: "Foo", last_name: "Bar", tags: ["new_tag"])
+```
+
+Note, tags specified in `update` will simply be added to the existing list of tags.
+
+###### To delete a single contact
+```ruby
+# perform operation directly
+AgileCRMWrapper::Contact.delete(123)
+# or
+AgileCRMWrapper::Contact.find(123).destroy
+```
+
+###### Convenient access to properties hash values
+```ruby
+contact.get_property("email")            #=> "blah@mail.com"
+contact.get_propety("my_custom_field")   #=> "im a custom field!"
+contact.get_property("unkown_attribute") #=> nil
+```
+
+### 2. Working with Notes
+
+###### To create a new note
+```ruby
+AgileCRMWrapper::Note.create(
+  subject: "My Note",
+  description: "My notes's description.",
+  contact_ids: ["123"]
+)
+```
+
+###### To add a Note to a Contact using Email-ID
+```ruby
+AgileCRMWrapper::Note.add_by_email(
+  email: "blah@mail.com",
+  subject: "My Note",
+  description: "My notes's description."
+)
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/nozpheratu/agilecrm-wrapper/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec 'pry -r agilecrm-wrapper -I ./lib'
+end

data/agilecrm.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agilecrm-wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'agilecrm-wrapper'
+  spec.version       = AgileCRMWrapper::VERSION
+  spec.authors       = ['Cyle']
+  spec.email         = ['cylehunter33@gmail.com']
+  spec.summary       = 'Ruby wrapper for Agile CRM API.'
+  spec.description   = 'Ruby wrapper for Agile CRM API.'
+  spec.homepage      = 'https://github.com/nozpheratu/agilecrm-wrapper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'sinatra'
+end

data/lib/agilecrm-wrapper.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'agilecrm-wrapper/version'
+require 'agilecrm-wrapper/configuration'
+require 'agilecrm-wrapper/contact'
+require 'agilecrm-wrapper/note'
+require 'agilecrm-wrapper/response/raise_error'
+
+module AgileCRMWrapper
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def endpoint
+      "https://#{configuration.domain}.agilecrm.com/dev/api"
+    end
+
+    def connection
+      @connection ||= default_connection
+    end
+
+    def default_connection
+      options = {
+        headers: { 'Accept' => 'application/json' }
+      }
+      Faraday.new(endpoint, options) do |conn|
+        conn.request(:json)
+        conn.request(:basic_auth, configuration.email, configuration.api_key)
+        conn.response(:json, content_type: /\bjson$/)
+        conn.response(:agilecrm_error)
+        conn.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/agilecrm-wrapper/configuration.rb

@@ -0,0 +1,11 @@
+module AgileCRMWrapper
+  class Configuration
+    attr_accessor :domain, :api_key, :email
+
+    def initialize
+      @domain = ''
+      @api_key = ''
+      @email = ''
+    end
+  end
+end

data/lib/agilecrm-wrapper/contact.rb

@@ -0,0 +1,119 @@
+require 'agilecrm-wrapper/error'
+require 'hashie'
+
+module AgileCRMWrapper
+  class Contact < Hashie::Mash
+    SYSTEM_PROPERTIES = %w(first_name last_name company title email)
+    CONTACT_FIELDS = %w(id type tags lead_score star_value)
+
+    class << self
+      def all
+        response = AgileCRMWrapper.connection.get('contacts')
+        if response.status == 200
+          return response.body.map { |body| new body }
+        else
+          return response
+        end
+      end
+
+      def find(id)
+        response = AgileCRMWrapper.connection.get("contacts/#{id}")
+        if response.status == 200
+          new(response.body)
+        elsif response.status == 204
+          fail(AgileCRMWrapper::NotFound.new(response))
+        end
+      end
+
+      def search_by_email(*emails)
+        emails = emails.flatten.compact.uniq
+        response = AgileCRMWrapper.connection.post(
+          'contacts/search/email', "email_ids=#{emails}",
+          'content-type' => 'application/x-www-form-urlencoded'
+        )
+        if response.body.size > 1
+          response.body.reject(&:nil?).map { |body| new body }
+        else
+          res = new(response.body.first)
+          res.empty? ? nil : res
+        end
+      end
+
+      def create(options = {})
+        payload = parse_contact_fields(options)
+        AgileCRMWrapper.connection.post('contacts', payload)
+      end
+
+      def delete(arg)
+        AgileCRMWrapper.connection.delete("contacts/#{arg}")
+      end
+
+      def parse_contact_fields(options)
+        payload = { 'properties' => [] }
+        options.each do |key, value|
+          if contact_field?(key)
+            payload[key.to_s] = value
+          else
+            payload['properties'] << parse_property(key, value)
+          end
+        end
+        payload
+      end
+
+      private
+
+      def parse_property(key, value)
+        if system_propety?(key)
+          { 'type' => 'SYSTEM', 'name' => key.to_s, 'value' => value }
+        else
+          { 'type' => 'CUSTOM', 'name' => key.to_s, 'value' => value }
+        end
+      end
+
+      def system_propety?(key)
+        SYSTEM_PROPERTIES.include?(key.to_s)
+      end
+
+      def contact_field?(key)
+        CONTACT_FIELDS.include?(key.to_s)
+      end
+    end
+
+    def destroy
+      self.class.delete(id)
+    end
+
+    def notes
+      response = AgileCRMWrapper.connection.get("contacts/#{id}/notes")
+      response.body.map { |note| AgileCRMWrapper::Note.new(note) }
+    end
+
+    def update(options = {})
+      payload = self.class.parse_contact_fields(options)
+      payload['properties'] = merge_properties(payload['properties'])
+      merge!(payload)
+      response = AgileCRMWrapper.connection.put('contacts', self)
+      merge!(response.body)
+    end
+
+    def get_property(property_name)
+      return unless respond_to?(:properties)
+      prop = properties.select { |a| a['name'] == property_name.to_s }
+      OpenStruct.new(*prop).value
+    end
+
+    private
+
+    def merge_properties(new_properties)
+      properties.map do |h|
+        new_properties.delete_if do |h2|
+          if h['name'] == h2['name']
+            h['value'] = h2['value']
+            true
+          end
+        end
+        h
+      end + new_properties
+    end
+  end
+end