relateiq_client 0.1.0

data/lib/relateiq/list.rb

@@ -0,0 +1,77 @@
+module RelateIq
+  class List
+    attr_accessor :id,
+                  :title,
+                  :list_type,
+                  :modified_date,
+                  :fields
+
+    def initialize(attrs = {})
+      if attrs.key? :listType
+        initialize_from_api(attrs)
+      else
+        initialize_from_user(attrs)
+      end
+    end
+
+    def self.resource
+      @resource ||= ServiceFactory.get_endpoint('lists')
+    end
+
+    def self.all
+      @all ||= from_json(resource.get)
+    end
+
+    def self.find_by_title(title)
+      all.find { |l| l.title.downcase == title.downcase }
+    end
+
+    def self.find(id)
+      all.find { |l| l.id == id }
+    end
+
+    def self.clean_cache
+      @all = nil
+    end
+
+    def self.from_json(json_string)
+      lists_hash = JSON.parse(json_string, symbolize_names: true)
+      if lists_hash.key? :objects
+        lists_hash[:objects].map { |li| List.new(li) }
+      else
+        List.new(lists_hash)
+      end
+    end
+
+    def upsert_item(list_item_hash)
+      list_item_hash.merge!(list_id: id)
+      list_item_class.new(list_item_hash).save
+    end
+
+    def items_by_contact_id(contact_id)
+      list_item_class.find_by_contact(id, contact_id)
+    end
+
+    private
+
+    def list_item_class
+      @list_item_class ||= ListItem
+    end
+
+    def initialize_from_api(attrs)
+      @id = attrs.fetch(:id)
+      @title = attrs.fetch(:title)
+      @fields = attrs.fetch(:fields)
+      @list_type = attrs.fetch(:listType)
+      @modified_date = attrs.fetch(:modifiedDate)
+    end
+
+    def initialize_from_user(attrs)
+      @id = attrs.fetch(:id, nil)
+      @title = attrs.fetch(:title, nil)
+      @list_type = attrs.fetch(:list_type, nil)
+      @modified_date = attrs.fetch(:modified_date, nil)
+      @fields = attrs.fetch(:fields, nil)
+    end
+  end
+end

data/lib/relateiq/list_item.rb

@@ -0,0 +1,107 @@
+module RelateIq
+  class ListItem
+    attr_accessor :list_id,
+                  :id,
+                  :name,
+                  :account_id,
+                  :contact_ids,
+                  :field_values
+
+    # field values always contains decoded values
+    # for example { 'Status' => 'Application Submitted' }
+
+    def initialize(attrs = {})
+      if attrs.key? :listId
+        initialize_from_api(attrs)
+      else
+        initialize_by_user(attrs)
+      end
+    end
+
+    def initialize_by_user(attrs)
+      @list_id = attrs.fetch(:list_id)
+      @id = attrs.fetch(:id, nil)
+      @name = attrs.fetch(:name, nil)
+      @account_id = attrs.fetch(:account_id, nil)
+      @contact_ids = attrs.fetch(:contact_ids, [])
+      @field_values = attrs.fetch(:field_values, [])
+    end
+
+    def initialize_from_api(attrs)
+      @list_id = attrs.fetch(:listId)
+      @id = attrs.fetch(:id, nil)
+      @name = attrs.fetch(:name, nil)
+      @account_id = attrs.fetch(:accountId, nil)
+      @contact_ids = attrs.fetch(:contactIds, [])
+      @field_values = decode_field_values(attrs.fetch(:fieldValues, nil))
+    end
+
+    def self.resource(list_id)
+      @resource ||= ServiceFactory.get_endpoint('lists')
+      @resource["#{list_id}/listitems"]
+    end
+
+    def self.from_json(json_string)
+      list_item_hash = JSON.parse(json_string, symbolize_names: true)
+      if list_item_hash.key? :objects
+        list_item_hash[:objects].map { |li| ListItem.new(li) }
+      else
+        ListItem.new(list_item_hash)
+      end
+    end
+
+    def self.create(attrs)
+      ListItem.new(attrs).save
+    end
+
+    def self.find_by_contact(list_id, contact_id)
+      from_json(resource(list_id)["?contactIds=#{contact_id}"].get)
+    end
+
+    def save
+      if id
+        ListItem.from_json(ListItem.resource(list_id)["#{id}"].put to_json)
+      else
+        ListItem.from_json(ListItem.resource(list_id).post to_json)
+      end
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+    private
+
+    def to_hash
+      result = { 'listId' => list_id }
+      result.merge!('id' => id) if id
+      result.merge!('name' => name) if name
+      result.merge!('accountId' => account_id) if account_id && list.list_type == 'account'
+      result.merge!('contactIds' => contact_ids) if contact_ids && contact_ids.count > 0
+      result.merge!('fieldValues' => encode_field_values(field_values)) if field_values && field_values.count > 0
+      result
+    end
+
+    def encode_field_values(values)
+      return [] unless values
+      encoder = field_value_encoder.new(list: list)
+      encoded_values = {}
+      values.each { |fv| encoded_values.merge!(encoder.encode(fv)) }
+      encoded_values
+    end
+
+    def decode_field_values(values)
+      return [] unless values
+      encoder = field_value_encoder.new(list: list)
+      values.map { |k, v| encoder.decode(k => v) }
+    end
+
+    def field_value_encoder
+      @field_value_encoder ||= RelateIq::Utils::FieldValueEncoder
+    end
+
+    def list
+      List.find(list_id)
+    end
+  end
+end

data/lib/relateiq/service_factory.rb

@@ -0,0 +1,12 @@
+module RelateIq
+  class ServiceFactory
+    def self.get_endpoint(endpoint)
+      RestClient::Resource.new(
+        "#{RelateIq.configuration.base_url}/#{endpoint}",
+        user: RelateIq.configuration.username,
+        password: RelateIq.configuration.password,
+        headers: { content_type: :json, accept: :json }
+      )
+    end
+  end
+end

data/lib/relateiq/utils/field_value_encoder.rb

@@ -0,0 +1,73 @@
+module RelateIq
+  module Utils
+    class FieldValueEncoder
+      attr_accessor :list
+
+      def initialize(attrs = {})
+        @list = attrs.fetch(:list)
+      end
+
+      def encode(decoded_value)
+        return {} if decoded_value.nil?
+        name = decoded_value.keys[0]
+        values = decoded_value.values[0]
+        field = find_field_by_name(name)
+        encoded_value = encode_values(field, values)
+        return {} if encoded_value == []
+        { "#{field[:id]}" =>  encoded_value }
+      end
+
+      def decode(encoded_value)
+        return {} if encoded_value.nil?
+        id = encoded_value.keys[0]
+        values = encoded_value.values[0]
+        field = find_field(id)
+        { "#{field[:name]}" => decode_values(field, values) }
+      end
+
+      private
+
+      def decode_values(field, field_values)
+        result = []
+        field_values.each { |fv| result << list_option_value(field, fv[:raw], 'id', 'display') }
+        result.count > 1 ? result : result[0]
+      end
+
+      def encode_values(field, field_values)
+        result = []
+        to_array(field_values).each do |fv|
+          list_option = list_option_value(field, fv, 'display', 'id')
+          result << { 'raw' => list_option } unless list_option.nil?
+        end
+        result
+      end
+
+      def list_option_value(field, value, key, value_key)
+        return nil if value.nil?
+        list_options = field[:listOptions]
+        if list_options && list_options.count > 0
+          option = list_options.find { |lo| lo[key.to_sym].downcase == value.downcase }
+          option ||= fail(FieldListOptionNotFoundError, key => value)
+          option[value_key.to_sym]
+        else
+          value
+        end
+      end
+
+      def find_field_by_name(name)
+        list.fields.find { |f| f[:name] == name } || fail(FieldNotFoundError, name)
+      end
+
+      def find_field(id)
+        list.fields.find { |f| f[:id] == id.to_s } || fail(FieldNotFoundError, id)
+      end
+
+      def to_array(value)
+        value.is_a?(Array) ? value : [value]
+      end
+    end
+
+    class FieldNotFoundError < StandardError; end
+    class FieldListOptionNotFoundError < StandardError; end
+  end
+end

data/lib/relateiq/version.rb

@@ -0,0 +1,3 @@
+module RelateIq
+  VERSION = "0.1.0"
+end

data/relateiq.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relateiq/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'relateiq_client'
+  s.version      = RelateIq::VERSION 
+  s.authors      = ['Dorian Karter']
+  s.email        = 'jobs@doriankarter.com'
+
+  s.summary      = 'Wrapper client for RelateIQ API'
+  s.description  = 'Wrapper client for RelateIQ allows using RelateIQ API from ruby'
+  s.homepage     = 'https://github.com/dkarter/relate_iq_client'
+  s.license      = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = [ 'lib' ]
+
+  s.add_dependency 'rest-client', '~> 1.7'
+
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~>3.1'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'pry-stack_explorer', '~> 0.4.9'
+  s.add_development_dependency 'zenflow'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-json'
+  s.add_development_dependency 'cadre'
+  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'webmock'
+end

data/spec/fixtures/account_by_id.json

@@ -0,0 +1,6 @@
+{
+  "id": "accountid",
+  "modifiedDate": 1423507504147,
+  "name": "Bolstr, Inc.",
+  "fieldValues": {}
+}

data/spec/fixtures/contact.json

@@ -0,0 +1,46 @@
+{
+  "id": "contactid",
+  "modifiedDate": 1424713865596,
+  "properties": {
+    "address": [
+      {
+        "value": "688 Dink rest, East Lu, Z2K 8OW",
+        "metadata": {}
+      }
+    ],
+    "company": [
+      {
+        "value": "Bolstr",
+        "metadata": {}
+      },
+      {
+        "value": "Bolstr, Inc.",
+        "metadata": {}
+      }
+    ],
+    "phone": [
+      {
+        "value": "+44 (0)5426658700",
+        "metadata": {}
+      }
+    ],
+    "name": [
+      {
+        "value": "Kipp Rice",
+        "metadata": {}
+      }
+    ],
+    "email": [
+      {
+        "value": "gulgowski.devyn@example.com",
+        "metadata": {}
+      }
+    ],
+    "liurl": [
+      {
+        "value": "https://www.linkedin.com/in/doriankarter",
+        "metadata": {}
+      }
+    ]
+  }
+}

data/spec/fixtures/contacts_by_email.json

@@ -0,0 +1,34 @@
+{
+  "objects": [
+    {
+      "id": "contactid",
+      "modifiedDate": 1424713865596,
+      "properties": {
+        "address": [
+          {
+            "value": "688 Dink rest, East Lu, Z2K 8OW",
+            "metadata": {}
+          }
+        ],
+        "phone": [
+          {
+            "value": "+44 (0)5426658700",
+            "metadata": {}
+          }
+        ],
+        "name": [
+          {
+            "value": "Kipp Rice",
+            "metadata": {}
+          }
+        ],
+        "email": [
+          {
+            "value": "gulgowski.devyn@example.com",
+            "metadata": {}
+          }
+        ]
+      }
+    }
+  ]
+}

data/spec/fixtures/list_item.json

@@ -0,0 +1,72 @@
+{
+  "id": "listitemid",
+  "listId": "list2id",
+  "version": 1,
+  "createdDate": 1417755155000,
+  "modifiedDate": 1421866566579,
+  "name": "Mack Koch",
+  "accountId": "accountid",
+  "contactIds": [
+    "contactid1",
+    "contactid2"
+  ],
+  "fieldValues": {
+    "0": [
+      {
+        "raw": "3"
+      }
+    ],
+    "15": [
+      {
+        "raw": "Boulder"
+      }
+    ],
+    "25": [
+      {
+        "raw": "5"
+      }
+    ],
+    "27": [
+      {
+        "raw": "30000"
+      }
+    ],
+    "40": [
+      {
+        "raw": "1417755155526"
+      }
+    ],
+    "43": [
+      {
+        "raw": "ec805c1d1effbc2768ce94108e30eeae74e15931"
+      }
+    ],
+    "44": [
+      {
+        "raw": "1"
+      }
+    ],
+    "45": [
+      {
+        "raw": "3"
+      }
+    ],
+    "46": [
+      {
+        "raw": "18"
+      }
+    ]
+  },
+  "linkedItemIds": {
+    "5ff139a60e6220c263558fbc0f26786050a70b34.accounts": [
+      {
+        "itemId": "4d7f9d97f6c00d41fcbfffad489f60f9d8cbfeb1"
+      }
+    ],
+    "list.cd669e1c0fa10a6a98639489807851415d3499d1": [
+      {
+        "itemId": "d7e41e76a945d9811aa7981fdd6a4ee5c28fdc05"
+      }
+    ]
+  }
+}