advisors_command_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec6b477a1d7c88df05c8922b5a251d097b0deb8e
+  data.tar.gz: a83b3e054ead8434bec05900ba0d6b61a11a6692
+SHA512:
+  metadata.gz: dc1633d60676da5e2f54ef1e352978d8941c2b353da7b7ec7f02b7f6d2e885dd755205bb10e03c605ed477c9b6850c23184e8d8902c12aeb753b24716fb7060c
+  data.tar.gz: b73b93d63d7263dacb609ff8d86d4f84cd9697d6716d7aebbb066bb1314ffe0250c2be377b0b4c7265d5653a2937e89319c4eaee7dc0322c9dc40475c2a51d48

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher Ostrowski
+
+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,55 @@
+# Advisors Command Client
+
+A small gem to use AdvisorsCommand in a ruby application.
+
+* Full support for WSSE authentication.
+* Simple Virtus POROs for models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'advisors_command'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install advisors_command
+
+## Usage
+
+Create a client:
+```ruby
+  $advisors_client = AdvisorsCommandClient::Client.new(username, api_key)
+```
+
+### Contacts
+Find contacts, returns a collection of `Model::Contact`
+```ruby
+  $advisors_client.contacts.search("Bob")
+```
+
+Find a single contact, returns a `Model::Contact`
+```ruby
+  $advisors_client.contacts.find(1234)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/RepPro/advisors_command/fork )
+2. Create your feature branch (`git checkout -b f/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin f/my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/advisors_command_client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'advisors_command_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "advisors_command_client"
+  spec.version       = AdvisorsCommandClient::VERSION
+  spec.authors       = ["Christopher Ostrowski"]
+  spec.email         = ["chris@madebyfunction.com"]
+
+  spec.summary       = %q{Ruby Client for integrating with Advisors Command CRM}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/RepPro/AdvisorsCommand"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "akami", "~> 1.3"
+  spec.add_dependency "typhoeus"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "virtus"
+  spec.add_dependency 'parallel'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "advisors_command"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/advisors_command_client.rb

@@ -0,0 +1,30 @@
+require 'virtus'
+require "advisors_command_client/version"
+require 'advisors_command_client/connection'
+require 'advisors_command_client/models/base'
+require 'advisors_command_client/models/contact'
+require 'advisors_command_client/models/contact_collection'
+
+module AdvisorsCommandClient
+  class SearchError < ::StandardError
+  end
+
+  class Client
+    TEST_URL = "https://qa.advisorscommand.com/api/rest/v1"
+    PROD_URL = "https://www.advisorscommand.com/api/rest/v1"
+    attr_reader :connection
+
+    def initialize(username, api_key, options = {})
+      if options[:live]
+        url = PROD_URL
+      else
+        url = TEST_URL
+      end
+      @connection = AdvisorsCommandClient::Connection.new(username, api_key, url).build
+    end
+
+    def contacts
+      @contacts ||= Models::ContactCollection.new(connection: @connection)
+    end
+  end
+end

data/lib/advisors_command_client/connection.rb

@@ -0,0 +1,48 @@
+require 'parallel'
+require 'akami'
+require 'faraday'
+require 'faraday_middleware'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+module AdvisorsCommandClient
+  class Connection
+
+    def initialize(username, api_key, url)
+      @username = username
+      @api_key = api_key
+      @url = url
+    end
+
+    def build
+      Faraday.new(@url) do |faraday|
+        faraday.request :url_encoded
+        faraday.use AdvisorsCommandClient::Connection::WsseAuth, @username, @api_key
+        faraday.adapter :typhoeus
+        faraday.response :json, content_type: /\bjson$/
+      end 
+    end
+
+    class WsseAuth < Faraday::Middleware
+      def initialize(app, username, api_key)
+        super(app)
+        @username = username
+        @api_key = api_key
+      end
+
+      def call(request_env)
+        request_env[:request_headers].merge!({"X-WSSE" => wsse_auth_string})
+        @app.call(request_env)
+      end
+
+      private
+      def wsse_auth_string
+        wsse = Akami.wsse
+        wsse.credentials @username, @api_key, :digest
+        wsse.timestamp = true
+
+        %{UsernameToken Username="#{wsse.username}", PasswordDigest="#{wsse.send(:digest_password)}", Nonce="#{Base64.encode64(wsse.send(:nonce)).chomp}", Created="#{wsse.send(:timestamp)}"}
+      end
+    end
+  end
+end

data/lib/advisors_command_client/models/base.rb

@@ -0,0 +1,32 @@
+module AdvisorsCommandClient
+  module Models
+    class Base
+      include Virtus.model
+
+      def self.load(hash)
+        new(deep_underscore_params(hash))
+      end
+
+      #JSON comes back as SnakeCase.
+      #This will convert all hash keys to snake_case.
+      def self.deep_underscore_params(val = {})
+        snake_caser = -> val {val.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase}
+
+        case val
+        when Array
+          val.map { |v| deep_underscore_params(v) }
+        when Hash
+          val.keys.each do |k, v = val[k]|
+            val.delete k
+            val[snake_caser.call(k)] = deep_underscore_params(v)
+          end
+          params = val
+        else
+          val
+        end
+
+        return val
+      end
+    end
+  end
+end

data/lib/advisors_command_client/models/contact.rb

@@ -0,0 +1,25 @@
+module AdvisorsCommandClient
+  module Models
+    class Contact < Base
+      attribute :id, Integer
+      attribute :nickname, String
+      attribute :first_name, String
+      attribute :middle_name, String
+      attribute :last_name, String
+      attribute :gender, String
+      attribute :birthday, DateTime
+      attribute :email, String
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+
+      attribute :emails, Array[Hash]
+      attribute :phones, Array[Hash]
+      attribute :addresses, Array[Hash]
+
+
+      def full_name
+        [first_name, middle_name, last_name].compact.join(' ')
+      end
+    end
+  end
+end

data/lib/advisors_command_client/models/contact_collection.rb

@@ -0,0 +1,30 @@
+module AdvisorsCommandClient
+  module Models
+    class ContactCollection
+      def initialize(args = {})
+        @connection = args[:connection]
+      end
+
+      def search(query)
+        response = @connection.get('search', {search: query, from: 'orocrm_contact'})
+        if response.success?
+          return Parallel.map(Array(response.body['data']), in_threads: 4) do |obj|
+            self.find(obj['record_id'].to_i)
+          end.compact
+        else
+          raise ::AdvisorsCommandClient::SearchError, "Error connecting to advisors command."
+        end
+      end
+
+      def find(contact_id)
+        resp = @connection.get("contacts/#{contact_id}")
+        if resp.success?
+          return AdvisorsCommandClient::Models::Contact.load(resp.body)
+        else
+          return nil
+        end
+      end
+
+    end
+  end
+end

data/lib/advisors_command_client/version.rb

@@ -0,0 +1,3 @@
+module AdvisorsCommandClient
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: advisors_command_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Ostrowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: akami
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chris@madebyfunction.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- advisors_command_client.gemspec
+- bin/console
+- bin/setup
+- lib/advisors_command_client.rb
+- lib/advisors_command_client/connection.rb
+- lib/advisors_command_client/models/base.rb
+- lib/advisors_command_client/models/contact.rb
+- lib/advisors_command_client/models/contact_collection.rb
+- lib/advisors_command_client/version.rb
+homepage: https://github.com/RepPro/AdvisorsCommand
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Client for integrating with Advisors Command CRM
+test_files: []