incontact 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 513309e9128c0cb13d3c3b43746668d09e83e9235f341bede89dd3c581b473a3
+  data.tar.gz: 3795681ee7683934a9ceaca74f7120bbe8e79a388dbc5b1c1fe6c6b29a3f9018
+SHA512:
+  metadata.gz: d7058cf29bee8230c705e9f1d398eb76945c50aa0f5ae339b10b75c9a9b04fd8e5a6e07980756ab94f8f13be4b7d7523a8eebccfd919c314e7e5f91ee2d08b33
+  data.tar.gz: 5e816f845862eeb2210ba6d9ea4d88a612ee7126bc18d32ff6142b6abd8cd29c0b34d1ac0b68430c020b42bfb3da12af8e031ff74bdbcec64577d09db4564b0c

data/.env

@@ -0,0 +1,9 @@
+# Used in tests
+
+export INCONTACT_TOKEN_URL=https://api.incontact.com/InContactAuthorizationServer/token
+export INCONTACT_APP_NAME=dashboard
+export INCONTACT_VENDOR_NAME=VeryGoodBusinessCo
+export INCONTACT_BUSINESS_UNIT_NUMBER=123456
+export INCONTACT_SCOPE="AdminApi RealTimeApi"
+export INCONTACT_PASSWORD=Apple123!
+export INCONTACT_USERNAME=dashboard@verygoodbusiness.com

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+*.DS_Store
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+.env.*

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - ruby-2.2.2
+cache:
+  - bundler
+  - apt
+sudo: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 CustomInk.com
+
+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,41 @@
+# InContact [![Build Status](https://travis-ci.org/customink/incontact_client.svg?branch=master)](https://travis-ci.org/customink/incontact_client)
+
+This gem is a library for accessing [InContact's API](https://developer.incontact.com/API)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'incontact'
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+The following environmental variables need to be defined. They will be used to set all configurations for the client
+without the need to customize a YAML config file. An example configuration:
+
+    export INCONTACT_TOKEN_URL=https://api.incontact.com/InContactAuthorizationServer/token
+    export INCONTACT_APP_NAME=dashboard
+    export INCONTACT_VENDOR_NAME=VeryGoodBusinessCo
+    export INCONTACT_BUSINESS_UNIT_NUMBER=123456
+    export INCONTACT_SCOPE="AdminApi RealTimeApi"            # Scope used for tokens. Leaving this blank will set scope to all APIs
+    export INCONTACT_USERNAME=dashboard@verygoodbusiness.com # Admin user who can access all data
+    export INCONTACT_PASSWORD=Apple123!
+
+It is recommended to use [dotenv](https://github.com/bkeepers/dotenv) to set
+your ENV variables.
+
+## Documentation
+
+[Api](docs/api.md)
+
+[Agents](docs/agents.md)
+
+[Agent Sessions](docs/agent_sessions.md)
+
+[Contacts](docs/contacts.md)
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require "rake/testtask"
+
+desc "Default: run unit tests."
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/docs/agent_sessions.md

@@ -0,0 +1,33 @@
+### Agent Sessions
+
+You can access agent session data using the `InContact::Api#agent_session` method.
+
+```ruby
+api            = InContact::Api.new
+agent_sessions = api.agent_sessions # => #<InContact::AgentSessions> instance
+```
+
+To join a session:
+
+```ruby
+# Pass in the Agent ID
+# Returns an InContact::Responses::AgentSessionRespose
+
+agent_session_response = agent_sessions.join_agent_session(1234567) # => {
+                                                                    #      "session_id" => 12346
+                                                                    #    }
+agent_session_response.session_id # => 123456
+```
+
+To mask and unmask a call:
+
+```ruby
+# Pass in session ID and contact ID
+
+session_id = 1234567
+contact_id = 7564313
+
+agent_sessions.mask_call(session_id, contact_id)  # => nil
+
+agent_session.unmask_call(session_id, contact_id) # => nil
+```

data/docs/agents.md

@@ -0,0 +1,54 @@
+### Agents
+
+You can access agent data using the `InContact::Api#agents` method.
+
+```ruby
+api    = InContact::Api.new
+agents = api.agents # => #<InContact::Agents> instance
+```
+
+To get all agents:
+
+```ruby
+# Returns an InContact::Responses::AgentResponse
+
+agent_response = agents.all # => {
+                            #      "business_unit_id" => 123467,
+                            #      "last_poll_time"   => "2017-04-25T19:12:22.117Z",
+                            #      "total_records"    => 1000,
+                            #      "agents"           => [...]
+                            #    }
+
+agent_response.total_records  # => 1000
+agent_response.agents         # Returns Array of agent data
+```
+
+To find one agent:
+
+```ruby
+# Returns an InContact::Responses::AgentResponse
+
+agent_response = agents.find(1234567) # => {
+                                      #      "business_unit_id" => 4592889,
+                                      #      "last_poll_time"   => "2017-04-21T18:12:32.120Z",
+                                      #      "agents"           => [...]
+                                      #    }
+
+# Returns the agents data
+# See InContact API for available data
+# The InContact APT returns data with keys in CamelCase
+agent = agent_response.agents.first  # => {
+                                     #      "agent_id"     => 1234567
+                                     #      "user_name"    => "billsmith@business.com"
+                                     #      "first_name"   => "Bill"
+                                     #      "last_name"    => "Smith"
+                                     #      "email_adress" => "billsmith@business.com"
+                                     #      "is_active"    => true
+                                     #      ...
+                                     #    }
+
+agent["first_name"]  # => "Bill"
+
+# The model is an OpenStruct, so this will also work
+agent.first_name     # => "Bill"
+```

data/docs/api.md

@@ -0,0 +1,12 @@
+### Api
+
+The `InContact::Api` class will be the main source to use the API.
+
+To set up:
+
+```ruby
+InContact::Api.new
+```
+
+That's it! This will automatically get a token for use in the API. Check the
+other docs for how to get specific data.

data/docs/contacts.md

@@ -0,0 +1,62 @@
+### Contacts
+
+You can access contact data using the `InContact::Api#contacts method`
+
+```ruby
+api      = InContact::Api.new
+contacts = api.contacts # => #<InContact::Contacts> instance
+```
+
+To get active Contacts:
+
+```ruby
+# Returns an InContact::Responses::ContactResponse
+
+contact_response = contacts.active # => {
+                                   #      "result_set" => {
+                                   #        "business_unit_id" => "4592889",
+                                   #        "last_poll_time"   => "2017-04-21T18:13:13.600Z",
+                                   #        "active_contacts"  => [...]
+                                   #      }
+                                   #    }
+
+# The active_contacts method contains array of contact data
+# See InContact API for all available data
+
+contact_response.active_contacts # => [
+                                 #      {
+                                 #        "agent_id"        => "1234568",
+                                 #        "campaign_id"     => "111111",
+                                 #        "campaign_name"   => "Test",
+                                 #        "contact_dd"      => "111111111",
+                                 #        "contact_start"   => "2017-04-21T18:12:53.123Z",
+                                 #        "first_name"      => "Bill",
+                                 #        "last_name"       => "Smith",
+                                 #        "media_type_name" => "Call",
+                                 #        ...
+                                 #      },
+                                 #      {
+                                 #        "agent_id"        => "1234569",
+                                 #        "campaign_id"     => "111112",
+                                 #        "campaign_name"   => "Test",
+                                 #        "contact_id"      => "111111112",
+                                 #        "contact_start"   => "2017-04-21T18:12:53.123Z",
+                                 #        "first_name"      => "Joe",
+                                 #        "last_name"       => "Johnson",
+                                 #        "media_type_name" => "Call",
+                                 #        ...
+                                 #      },
+                                 #      ...
+                                 #     ]
+
+# Getting some data
+
+
+contact = contact_response.active_contacts.first
+contact["first_name"] # => "Bill"
+
+# The model is an OpenStruct, so this will also work
+contact.first_name    # => "Bill"
+```
+
+

data/incontact.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "incontact/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "incontact"
+  spec.version     = InContact::VERSION
+  spec.authors     = ["Spreemo"]
+  spec.email       = ["engineering@spreemo.com"]
+  spec.description = "A Ruby gem to access the InContact API"
+  spec.summary     = spec.description
+  spec.homepage    = "https://github.com/spreemo/incontact_client"
+  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{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "retryable"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rake"
+end

data/lib/incontact.rb

@@ -0,0 +1,38 @@
+require "active_support/all"
+require "retryable"
+require "faraday"
+require "faraday_middleware"
+require "incontact/error"
+require "incontact/version"
+require "ostruct"
+
+module InContact
+  autoload :Api,                        "incontact/api"
+  autoload :Tokens,                     "incontact/tokens"
+  autoload :Connection,                 "incontact/connection"
+  autoload :TokenAuthenticatedResource, "incontact/token_authenticated_resource"
+  autoload :Agents,                     "incontact/agents"
+  autoload :Contacts,                   "incontact/contacts"
+  autoload :AgentSessions,              "incontact/agent_sessions"
+  autoload :CallLists,                  "incontact/call_lists"
+  autoload :Dispositions,               "incontact/dispositions"
+  autoload :Resources,                  "incontact/resources"
+
+  module Models
+    autoload :Token,        "incontact/models/token"
+    autoload :Agent,        "incontact/models/agent"
+    autoload :Contact,      "incontact/models/contact"
+    autoload :AgentSession, "incontact/models/agent_session"
+    autoload :CallList,     "incontact/models/call_list"
+    autoload :Disposition,  "incontact/models/disposition"
+  end
+
+  module Responses
+    autoload :ContactResponse,      "incontact/responses/contact_response"
+    autoload :AgentResponse,        "incontact/responses/agent_response"
+    autoload :AgentSessionResponse, "incontact/responses/agent_session_response"
+    autoload :CallListResponse,     "incontact/responses/call_list_response"
+    autoload :CallListResponse,     "incontact/responses/call_list_response"
+    autoload :DispositionResponse,   "incontact/responses/disposition_response"
+  end
+end

data/lib/incontact/agent_sessions.rb

@@ -0,0 +1,16 @@
+module InContact
+  class AgentSessions < TokenAuthenticatedResource
+    def join_agent_session(agent_id)
+      agent_request_data = { "asAgentId" => agent_id }
+      connection.post("agent-sessions/join", agent_request_data)
+    end
+
+    def mask_call(session_id, contact_id)
+      connection.post("agent-sessions/#{session_id}/interactions/#{contact_id}/mask")
+    end
+
+    def unmask_call(session_id, contact_id)
+      connection.post("agent-sessions/#{session_id}/interactions/#{contact_id}/unmask")
+    end
+  end
+end

data/lib/incontact/agents.rb

@@ -0,0 +1,11 @@
+module InContact
+  class Agents < TokenAuthenticatedResource
+    def all
+      connection.get("agents")
+    end
+
+    def find(agent_id)
+      connection.get("agents/#{agent_id}")
+    end
+  end
+end

data/lib/incontact/api.rb

@@ -0,0 +1,43 @@
+module InContact
+  class Api
+    attr_reader :token
+
+    def initialize
+      @token = InContact::Tokens.get
+    end
+
+    def agents
+      @agents ||= create_resource(InContact::Resources::AGENTS)
+    end
+
+    def contacts
+      @contacts ||= create_resource(InContact::Resources::CONTACTS)
+    end
+
+    def agent_sessions
+      @agent_sessions ||=  create_resource(InContact::Resources::AGENT_SESSIONS)
+    end
+
+    def call_lists
+      @call_lists ||=  create_resource(InContact::Resources::CALL_LISTS)
+    end
+
+    private
+
+    def create_resource(resource)
+      resource_model = "InContact::#{resource}".constantize
+      data_model     = "InContact::Responses::#{resource.singularize}Response".constantize
+      connection     = create_connection(data_model)
+
+      resource_model.new(connection)
+    end
+
+    def create_connection(data_model)
+      url           = token.resource_server_base_uri
+      authorization = token.authorization
+      options       = { default_data_model: data_model }
+
+      InContact::Connection.new(url, authorization, options)
+    end
+  end
+end

data/lib/incontact/api_test.rb

@@ -0,0 +1,31 @@
+module InContact
+  class ApiTest < TestCase
+    before do
+      mock_request(:post, "", 200, "token", body, ENV["INCONTACT_TOKEN_URL"])
+    end
+
+    let(:api) { InContact::Api.new }
+
+    it "will get a token on initialization" do
+      api.token.wont_be_nil
+    end
+
+    describe "#agents" do
+      it "will return an agent resource class" do
+        api.agents.must_be_kind_of InContact::Agents
+      end
+    end
+
+    describe "#agent_sessions" do
+      it "will return an agent session resource class" do
+        api.agents.must_be_kind_of InContact::AgentSessions
+      end
+    end
+
+    describe "#agents" do
+      it "will return a contact resource class" do
+        api.agents.must_be_kind_of InContact::Contacts
+      end
+    end
+  end
+end

data/lib/incontact/call_lists.rb

@@ -0,0 +1,19 @@
+module InContact
+  class CallLists < TokenAuthenticatedResource
+    def all
+      connection.get("lists/call-lists")
+    end
+
+    def find(call_list_id)
+      connection.get("lists/call-lists/#{call_list_id}")
+    end
+
+    def upload_file(call_list_id, body)
+      connection.post("lists/call-lists/#{call_list_id}/upload", body)
+    end
+
+    def create(body)
+      connection.post("lists/call-lists", body)
+    end
+  end
+end

data/lib/incontact/connection.rb

@@ -0,0 +1,124 @@
+module InContact
+  class Connection
+    TIMEOUT         = 60
+    OPEN_TIMEOUT    = 10
+    MAX_TRIES       = 2
+    RETRY_SLEEP     = 1
+    API_PATH_PREFIX = "services/v8.0/"
+
+    attr_reader :url
+    attr_reader :authorization
+    attr_reader :default_data_model
+
+    def initialize(url, authorization, options = {})
+      @url                = url
+      @authorization      = authorization
+      @default_data_model = options[:default_data_model] || OpenStruct
+    end
+
+    def get(path, params = {})
+      request :get, path, params
+    end
+
+    def post(path, payload = "", params = {})
+      request :post, path, params, payload
+    end
+
+    def request(type, path, params = {}, body=nil)
+      timeout_override      = params.delete :timeout
+      open_timeout_override = params.delete :open_timeout
+      data_model_override   = params.delete :data_model_override
+      response              = Retryable.retryable(retryable_options(params)) do
+        request_with_exception_handling do
+          connection.send(type) do |req|
+            req.path                   = API_PATH_PREFIX + path unless path.blank?
+            req.options[:timeout]      = timeout_override      || TIMEOUT
+            req.options[:open_timeout] = open_timeout_override || OPEN_TIMEOUT
+            req.params                 = params
+            req.body                   = body.to_json unless body.blank?
+          end
+        end
+      end
+      raise_response_errors(response)
+      parse_response(response, data_model_override)
+    end
+
+    private
+
+    def retryable_options(options)
+      {}.tap do |retry_options|
+        retry_options[:tries] = options.delete(:max_tries)   || MAX_TRIES
+        retry_options[:sleep] = options.delete(:retry_sleep) || RETRY_SLEEP
+        retry_options[:on]    = [ConnectionError]
+      end
+    end
+
+    def request_with_exception_handling
+      yield
+    rescue => exception
+      raise ConnectionError, exception
+    end
+
+    def raise_response_errors(response)
+      return if response.success?
+      error_messages = response.body.respond_to?(:exception_message) &&
+        response.body.errors.present? ? response.body.errors.join("\n") : ""
+      case response.status
+      when 404
+        raise ResourceNotFound.new(error_messages, response)
+      when 400...600
+        raise Error.new(error_messages, response)
+      end
+    end
+
+    def connection
+      @connection ||= create_connection
+    end
+
+    def create_connection
+      Faraday.new(url: url) do |faraday|
+        faraday.headers["Accept-Encoding"] = "none"
+        faraday.headers["Content-Type"]    = "application/json; charset=utf-8"
+        faraday.headers["Authorization"]   = authorization
+        faraday.use FaradayMiddleware::ParseJson
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def parse_response(response, data_model_override)
+      data = response.body
+      map_response_item_to_model(data, data_model_override)
+    end
+
+    def data_model(item)
+      klass = name.demodulize.underscore.singularize.classify
+      "InContact::Responses::#{klass}Response".constantize rescue nil
+    end
+
+    def map_response_item_to_model(item, data_model_override)
+      return item if item.blank? || data_model_override.is_a?(FalseClass)
+
+      # Change keys to snake case
+      item = underscore_hash_keys(item)
+      data_model_klass = data_model_override || default_data_model
+      return item if data_model_klass.nil?
+      data_model_klass.new(item)
+    end
+
+    # Based on ActiveSupport's Hash#deep_transform_keys, which is only available in
+    # versions >= 4.0.2. We'll port it here to work with versions < 4.0.2
+    # Source: https://github.com/rails/rails/blob/55f9b8129a50206513264824abb44088230793c2/activesupport/lib/active_support/core_ext/hash/keys.rb#L143-L154
+    def underscore_hash_keys(item)
+      case item
+      when Hash
+        item.each_with_object({}) do |(key, value), result|
+          result[key.underscore] = underscore_hash_keys(value)
+        end
+      when Array
+        item.map { |value| underscore_hash_keys(value) }
+      else
+        item
+      end
+    end
+  end
+end

data/lib/incontact/contacts.rb

@@ -0,0 +1,7 @@
+module InContact
+  class Contacts < TokenAuthenticatedResource
+    def active
+      connection.get("contacts/active")
+    end
+  end
+end

data/lib/incontact/dispositions.rb

@@ -0,0 +1,7 @@
+module InContact
+  class Dispositions < TokenAuthenticatedResource
+    def all
+      connection.get("dispositions")
+    end
+  end
+end

data/lib/incontact/error.rb

@@ -0,0 +1,20 @@
+module InContact
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(exception, response = nil)
+      @response = response
+      if exception.instance_of? Faraday::Error::ClientError
+        super exception.message
+      elsif exception.is_a? String
+        super exception
+      else
+        super "Unknown exception: #{exception.message}"
+      end
+    end
+  end
+
+  class ConnectionError < Error ; end
+  class ResourceError < Error ; end
+  class ResourceNotFound < ResourceError ; end
+end

data/lib/incontact/models/agent.rb

@@ -0,0 +1,6 @@
+module InContact
+  module Models
+    class Agent < OpenStruct
+    end
+  end
+end

data/lib/incontact/models/call_list.rb

@@ -0,0 +1,6 @@
+module InContact
+  module Models
+    class CallList < OpenStruct
+    end
+  end
+end

data/lib/incontact/models/contact.rb

@@ -0,0 +1,6 @@
+module InContact
+  module Models
+    class Contact < OpenStruct
+    end
+  end
+end

data/lib/incontact/models/disposition.rb

@@ -0,0 +1,7 @@
+module InContact
+  module Models
+    class Disposition < OpenStruct
+    end
+  end
+end
+

data/lib/incontact/models/token.rb

@@ -0,0 +1,9 @@
+module InContact
+  module Models
+    class Token < OpenStruct
+      def authorization
+        "#{token_type} #{access_token}"
+      end
+    end
+  end
+end

data/lib/incontact/resources.rb

@@ -0,0 +1,9 @@
+module InContact
+  module Resources
+    AGENTS         = "Agents"
+    AGENT_SESSIONS = "AgentSessions"
+    CONTACTS       = "Contacts"
+    CALL_LISTS     = "CallLists"
+    DISPOSITIONS   = "Dispositions"
+  end
+end

data/lib/incontact/responses/agent_response.rb

@@ -0,0 +1,11 @@
+module InContact
+  module Responses
+    class AgentResponse < OpenStruct
+      def agents
+        @agents ||= self["agents"].map do |agent|
+          InContact::Models::Agent.new(agent)
+        end
+      end
+    end
+  end
+end

data/lib/incontact/responses/agent_session_response.rb

@@ -0,0 +1,6 @@
+module InContact
+  module Responses
+    class AgentSessionResponse < OpenStruct
+    end
+  end
+end

data/lib/incontact/responses/call_list_response.rb

@@ -0,0 +1,11 @@
+module InContact
+  module Responses
+    class CallListResponse < OpenStruct
+      def call_list
+        @call_lists ||= self["callingLists"].map do |call_list|
+          InContact::Models::CallList.new(call_list)
+        end
+      end
+    end
+  end
+end

data/lib/incontact/responses/contact_response.rb

@@ -0,0 +1,11 @@
+module InContact
+  module Responses
+    class ContactResponse < OpenStruct
+      def active_contacts
+        @active_contacts ||= self["result_set"]["active_contacts"].map do |contact|
+          InContact::Models::Contact.new(contact)
+        end
+      end
+    end
+  end
+end

data/lib/incontact/responses/disposition_response.rb

@@ -0,0 +1,12 @@
+module InContact
+  module Responses
+    class DispositionResponse < OpenStruct
+      def dispositions
+        @dispositions ||= self["result_set"]["dispositions"].map do |disposition|
+          InContact::Models::Disposition.new(disposition)
+        end
+      end
+    end
+  end
+end
+

data/lib/incontact/token_authenticated_resource.rb

@@ -0,0 +1,10 @@
+module InContact
+  class TokenAuthenticatedResource
+
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+  end
+end

data/lib/incontact/tokens.rb

@@ -0,0 +1,49 @@
+require "base64"
+
+module InContact
+  class Tokens
+    class << self
+
+      def get
+        Connection.new(url, authorization, token_options).post(path, token_request_data)
+      end
+
+      private
+
+      def url
+        ENV["INCONTACT_TOKEN_URL"]
+      end
+
+      def path
+        ""
+      end
+
+      def token_request_data
+        {
+          grant_type: "password",
+          username:   ENV["INCONTACT_USERNAME"],
+          password:   ENV["INCONTACT_PASSWORD"],
+          scope:      ENV["INCONTACT_SCOPE"]
+        }
+      end
+
+      def token_options
+        {
+          default_data_model: InContact::Models::Token
+        }
+      end
+
+      def authorization
+        "basic #{encoded_auth_string}"
+      end
+
+      def auth_string
+        "#{ENV["INCONTACT_APP_NAME"]}@#{ENV["INCONTACT_VENDOR_NAME"]}:#{ENV["INCONTACT_BUSINESS_UNIT_NUMBER"]}"
+      end
+
+      def encoded_auth_string
+        Base64.encode64(auth_string).chomp
+      end
+    end
+  end
+end

data/lib/incontact/version.rb

@@ -0,0 +1,3 @@
+module InContact
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: incontact
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Spreemo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-27 00:00:00.000000000 Z
+dependencies:
+- !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: retryable
+  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: activesupport
+  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: dotenv
+  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: 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: minitest
+  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: webmock
+  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: rake
+  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'
+description: A Ruby gem to access the InContact API
+email:
+- engineering@spreemo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/agent_sessions.md
+- docs/agents.md
+- docs/api.md
+- docs/contacts.md
+- incontact.gemspec
+- lib/incontact.rb
+- lib/incontact/agent_sessions.rb
+- lib/incontact/agents.rb
+- lib/incontact/api.rb
+- lib/incontact/api_test.rb
+- lib/incontact/call_lists.rb
+- lib/incontact/connection.rb
+- lib/incontact/contacts.rb
+- lib/incontact/dispositions.rb
+- lib/incontact/error.rb
+- lib/incontact/models/agent.rb
+- lib/incontact/models/call_list.rb
+- lib/incontact/models/contact.rb
+- lib/incontact/models/disposition.rb
+- lib/incontact/models/token.rb
+- lib/incontact/resources.rb
+- lib/incontact/responses/agent_response.rb
+- lib/incontact/responses/agent_session_response.rb
+- lib/incontact/responses/call_list_response.rb
+- lib/incontact/responses/contact_response.rb
+- lib/incontact/responses/disposition_response.rb
+- lib/incontact/token_authenticated_resource.rb
+- lib/incontact/tokens.rb
+- lib/incontact/version.rb
+homepage: https://github.com/spreemo/incontact_client
+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.7.5
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to access the InContact API
+test_files: []