amorail 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a49cf3e73052b401ec558f46cf546671cefd4ba
-  data.tar.gz: 05204059536051197800da4bd8f784c9dd13b0d2
+  metadata.gz: f73b954b7479f45998e9934162fbb77088770d26
+  data.tar.gz: 738477b6b61034bc74376805c2801936957616d4
 SHA512:
-  metadata.gz: ecdea4ff97ea0018b2b25cce5e049fef9fb8c7ecea9fffe88777f4b25fa0b98378233d8ef3abbd4adf27c29d8ceee205621339e2db4d3697392ea375e63ee484
-  data.tar.gz: 24379dc6fc1498860dadda55c13ebacf7bba1ccab4b9a058aad304eb22dbd2d64e7d10386e23f3f1d14912b11830c5dd23cd0c62f274f8e7f361a46ccb511cc7
+  metadata.gz: 56e949043eb9234d5ee67698c6f6fd46bbca5012bf913487e777122c7e748ea33523e86b80de3ac0b5e0facd9670b01cbf570735a2089518f28e3248b12e0a4e
+  data.tar.gz: 50bdcbb2c1280922828b3291901311fcb0eae9a023ccf89f271c6586cf983668237295a9998ae85de3cba43ca55ca2fb41cf357e8830bdae0d3b237bb0b7a50e

data/README.md

@@ -211,10 +211,29 @@ rake amorail:check
 ```
 Rake task will returns information about properties.
 
+### Multiple configurations
+
+It is possible to use Amorail with multiple AmoCRM accounts. To do so use `Amorail.with_client` method,
+which receive client params or client instance and a block to execute within custom context:
+
+```ruby
+Amorail.with_client(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key") do
+  # Client specific code here
+end
+
+# or using client instance
+my_client = Amorail::Client.new(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key")
+
+Amorail.with_client(client) do
+  ...
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/amorail/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
+4. Follow style guides (use Rubocop)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/amorail.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'shoulda-matchers', "~> 2.0"

data/lib/amorail.rb

@@ -15,7 +15,7 @@ module Amorail
   end
 
   def self.properties
-    @properties ||= Property.new(client)
+    client.properties
   end
 
   def self.configure
@@ -23,7 +23,7 @@ module Amorail
   end
 
   def self.client
-    @client ||= Client.new
+    ClientRegistry.client || (@client ||= Client.new)
   end
 
   def self.reset
@@ -31,5 +31,18 @@ module Amorail
     @client = nil
   end
 
+  def self.with_client(client)
+    client = Client.new(client) unless client.is_a?(Client)
+    ClientRegistry.client = client
+    yield
+    ClientRegistry.client = nil
+  end
+
+  class ClientRegistry # :nodoc:
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_accessor :client
+  end
+
   require 'amorail/engine' if defined?(Rails)
 end

data/lib/amorail/client.rb

@@ -6,17 +6,25 @@ require 'active_support'
 module Amorail
   # Amorail http client
   class Client
-    attr_accessor :cookies
+    attr_reader :usermail, :api_key, :api_endpoint
 
-    def initialize
-      @host = Amorail.config.api_endpoint
-      @connect = Faraday.new(url: @host) do |faraday|
+    def initialize(api_endpoint: Amorail.config.api_endpoint,
+                   api_key: Amorail.config.api_key,
+                   usermail: Amorail.config.usermail)
+      @api_endpoint = api_endpoint
+      @api_key = api_key
+      @usermail = usermail
+      @connect = Faraday.new(url: api_endpoint) do |faraday|
         faraday.adapter Faraday.default_adapter
         faraday.response :json, content_type: /\bjson$/
         faraday.use :instrumentation
       end
     end
 
+    def properties
+      @properties ||= Property.new(self)
+    end
+
     def connect
       @connect || self.class.new
     end
@@ -25,8 +33,8 @@ module Amorail
       self.cookies = nil
       response = post(
         Amorail.config.auth_url,
-        'USER_LOGIN' => Amorail.config.usermail,
-        'USER_HASH' => Amorail.config.api_key
+        'USER_LOGIN' => usermail,
+        'USER_HASH' => api_key
       )
       cookie_handler(response)
       response
@@ -55,6 +63,10 @@ module Amorail
       handle_response(response)
     end
 
+    private
+
+    attr_accessor :cookies
+
     def cookie_handler(response)
       self.cookies = response.headers['set-cookie'].split('; ')[0]
     end

data/lib/amorail/entities/contact_link.rb

@@ -9,7 +9,7 @@ module Amorail
       # Find links by contacts ids
       def find_by_contacts(*ids)
         ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
-        response = Amorail.client.safe_request(
+        response = client.safe_request(
           :get,
           remote_url('links'),
           contacts_link: ids
@@ -20,7 +20,7 @@ module Amorail
       # Find links by leads ids
       def find_by_leads(*ids)
         ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
-        response = Amorail.client.safe_request(
+        response = client.safe_request(
           :get,
           remote_url('links'),
           deals_link: ids

data/lib/amorail/entity.rb

@@ -12,6 +12,8 @@ module Amorail
     class << self
       attr_reader :amo_name, :amo_response_name
 
+      delegate :client, to: Amorail
+
       # copy Amo names
       def inherited(subclass)
         subclass.amo_names amo_name, amo_response_name
@@ -51,8 +53,8 @@ module Amorail
     amo_field :id, :request_id, :responsible_user_id,
               date_create: :timestamp, last_modified: :timestamp
 
-    delegate :client, :properties, to: Amorail
-    delegate :amo_name, :remote_url, to: :class
+    delegate :amo_name, :remote_url, :client, to: :class
+    delegate :properties, to: Amorail
 
     def initialize(attributes = {})
       super(attributes)

data/lib/amorail/entity/finders.rb

@@ -17,7 +17,7 @@ module Amorail # :nodoc: all
       def find_all(*ids)
         ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
 
-        response = Amorail.client.safe_request(
+        response = client.safe_request(
           :get,
           remote_url('list'),
           id: ids
@@ -28,7 +28,7 @@ module Amorail # :nodoc: all
       # Find AMO entities by query
       # Returns array of matching entities.
       def find_by_query(q)
-        response = Amorail.client.safe_request(
+        response = client.safe_request(
           :get,
           remote_url('list'),
           query: q

data/lib/amorail/entity/params.rb

@@ -46,7 +46,6 @@ module Amorail # :nodoc: all
     end
 
     # this method removes nil values and empty arrays from params hash (deep)
-    # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
     def normalize_params(data)
@@ -71,7 +70,6 @@ module Amorail # :nodoc: all
       end
       compacted.with_indifferent_access
     end
-    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 

data/lib/amorail/version.rb

@@ -1,4 +1,4 @@
 # Amorail version
 module Amorail
-  VERSION = "0.2.0"
+  VERSION = "0.3.0".freeze
 end

data/spec/client_spec.rb

@@ -5,19 +5,119 @@ describe Amorail::Client do
 
   before(:each) { mock_api }
 
-  it "it should create client" do
-    expect(Amorail.config.usermail).to eq "amorail@test.com"
-    expect(Amorail.config.api_key).to eq "75742b166417fe32ae132282ce178cf6"
-    expect(Amorail.config.api_endpoint).to eq "https://test.amocrm.ru"
-  end
+  context "default client" do
+    it "should create client", :aggregate_failures do
+      expect(subject.usermail).to eq "amorail@test.com"
+      expect(subject.api_key).to eq "75742b166417fe32ae132282ce178cf6"
+      expect(subject.api_endpoint).to eq "https://test.amocrm.ru"
+    end
+
+    it "should #authorize method call" do
+      res = client.authorize
+      expect(res.status).to eq 200
+    end
 
-  it "should #authorize method call" do
-    res = client.authorize
-    expect(res.status).to eq 200
+    it "should #authorize and set cookie" do
+      res = client.get("/private/api/v2/json/accounts/current")
+      expect(res.status).to eq 200
+    end
   end
 
-  it "should #authorize and set cookie" do
-    res = client.get("/private/api/v2/json/accounts/current")
-    expect(res.status).to eq 200
+  describe "#with_client" do
+    before { mock_custom_api("https://custom.amo.com", "custom@amo.com", "123") }
+
+    let(:new_client) do
+      described_class.new(
+        api_endpoint: "https://custom.amo.com",
+        usermail: "custom@amo.com",
+        api_key: "123"
+      )
+    end
+
+    it "use custom client as instance", :aggregate_failures do
+      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      Amorail.with_client(new_client) do
+        expect(Amorail.client.usermail).to eq "custom@amo.com"
+        expect(Amorail.client.api_endpoint).to eq "https://custom.amo.com"
+        expect(Amorail.client.api_key).to eq "123"
+      end
+
+      expect(Amorail.client.usermail).to eq "amorail@test.com"
+    end
+
+    it "use custom client as options", :aggregate_failures do
+      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      Amorail.with_client(
+        api_endpoint: "https://custom.amo.com",
+        usermail: "custom@amo.com",
+        api_key: "123"
+      ) do
+        expect(Amorail.client.usermail).to eq "custom@amo.com"
+        expect(Amorail.client.api_endpoint).to eq "https://custom.amo.com"
+        expect(Amorail.client.api_key).to eq "123"
+      end
+
+      expect(Amorail.client.usermail).to eq "amorail@test.com"
+    end
+
+    it "loads custom properties", :aggregate_failures do
+      expect(Amorail.properties.company.phone.id).to eq "1460589"
+
+      Amorail.with_client(new_client) do
+        expect(Amorail.properties.company.phone.id).to eq "301"
+      end
+
+      expect(Amorail.properties.company.phone.id).to eq "1460589"
+    end
+
+    it "threadsafe", :aggregate_failures do
+      results = []
+      q1 = Queue.new
+      q2 = Queue.new
+      q3 = Queue.new
+      threads = []
+
+      # This thread enters block first but commits result
+      # only after the second thread enters block
+      threads << Thread.new do
+        q1.pop
+        Amorail.with_client(usermail: 'test1@amo.com') do
+          q2 << 1
+          q1.pop
+          results << Amorail.client.usermail
+          q2 << 1
+        end
+        q3 << 1
+      end
+
+      # This thread enters block second and commits result
+      # after the first block
+      threads << Thread.new do
+        q2.pop
+        Amorail.with_client(usermail: 'test2@amo.com') do
+          q1 << 1
+          q2.pop
+          results << Amorail.client.usermail
+        end
+        q3 << 1
+      end
+
+      # This thread enters block third and commits
+      # after all other threads left blocks
+      threads << Thread.new do
+        Amorail.with_client(usermail: 'test3@amo.com') do
+          q3.pop
+          q3.pop
+          results << Amorail.client.usermail
+        end
+      end
+
+      q1 << 1
+      threads.each(&:join)
+
+      expect(results[0]).to eq 'test1@amo.com'
+      expect(results[1]).to eq 'test2@amo.com'
+      expect(results[2]).to eq 'test3@amo.com'
+    end
   end
 end

data/spec/fixtures/account2_response.json

@@ -0,0 +1,195 @@
+{
+  "response": {
+    "account": {
+      "id": "101",
+      "name": "База клиентов",
+      "subdomain": "custom_test",
+      "currency": "RUB",
+      "paid_from": false,
+      "paid_till": false,
+      "timezone": "Europe/Moscow",
+      "language": "ru",
+      "date_pattern": "d.m.Y H:i",
+      "limits": {
+        "users_count": false,
+        "contacts_count": false,
+        "active_deals_count": false
+      },
+      "users": [
+        {
+          "id": "337914",
+          "name": "sergey",
+          "last_name": null,
+          "login": "alekseenkoss@gmail.com",
+          "group_id": 0,
+          "rights_lead_add": "A",
+          "rights_lead_view": "A",
+          "rights_lead_edit": "A",
+          "rights_lead_delete": "A",
+          "rights_lead_export": "A",
+          "rights_contact_add": "A",
+          "rights_contact_view": "A",
+          "rights_contact_edit": "A",
+          "rights_contact_delete": "A",
+          "rights_contact_export": "A",
+          "rights_company_add": "A",
+          "rights_company_view": "A",
+          "rights_company_edit": "A",
+          "rights_company_delete": "A",
+          "rights_company_export": "A",
+          "is_admin": "Y"
+        }
+      ],
+      "groups": [],
+      "leads_statuses": [
+        {
+          "name": "Demo",
+          "id": "101",
+          "color": "#99CCFF",
+          "editable": "Y",
+          "sort": "10"
+        },
+        {
+          "name": "Closed",
+          "id": "102",
+          "color": "#FFFF99",
+          "editable": "Y",
+          "sort": "20"
+        }
+      ],
+      "custom_fields": {
+        "contacts": [
+          {
+            "id": "201",
+            "name": "Должность",
+            "code": "POSITION",
+            "multiple": "N",
+            "type_id": "1",
+            "disabled": "0"
+          },
+          {
+            "id": "202",
+            "name": "Телефон",
+            "code": "PHONE",
+            "multiple": "Y",
+            "type_id": "8",
+            "disabled": "0",
+            "enums": {
+              "3392086": "WORK",
+              "3392088": "WORKDD",
+              "3392090": "MOB",
+              "3392092": "FAX",
+              "3392094": "HOME",
+              "3392096": "OTHER"
+            }
+          },
+          {
+            "id": "203",
+            "name": "Email",
+            "code": "EMAIL",
+            "multiple": "Y",
+            "type_id": "8",
+            "disabled": "0",
+            "enums": {
+              "3392098": "WORK",
+              "3392100": "PRIV",
+              "3392102": "OTHER"
+            }
+          },
+          {
+            "id": "204",
+            "name": "Мгн. сообщения",
+            "code": "IM",
+            "multiple": "Y",
+            "type_id": "8",
+            "disabled": "0",
+            "enums": {
+              "3392104": "SKYPE",
+              "3392106": "ICQ",
+              "3392108": "JABBER",
+              "3392110": "GTALK",
+              "3392112": "MSN",
+              "3392114": "OTHER"
+            }
+          }
+        ],
+        "leads": [],
+        "companies": [
+          {
+            "id": "301",
+            "name": "Телефон",
+            "code": "PHONE",
+            "multiple": "Y",
+            "type_id": "8",
+            "disabled": "0",
+            "enums": {
+              "3392086": "WORK",
+              "3392088": "WORKDD",
+              "3392090": "MOB",
+              "3392092": "FAX",
+              "3392094": "HOME",
+              "3392096": "OTHER"
+            }
+          },
+          {
+            "id": "302",
+            "name": "Email",
+            "code": "EMAIL",
+            "multiple": "Y",
+            "type_id": "8",
+            "disabled": "0",
+            "enums": {
+              "3392098": "WORK",
+              "3392100": "PRIV",
+              "3392102": "OTHER"
+            }
+          },
+          {
+            "id": "303",
+            "name": "Web",
+            "code": "WEB",
+            "multiple": "N",
+            "type_id": "7",
+            "disabled": "0"
+          },
+          {
+            "id": "304",
+            "name": "Адрес",
+            "code": "ADDRESS",
+            "multiple": "N",
+            "type_id": "9",
+            "disabled": "0"
+          }
+        ]
+      },
+      "note_types": [
+        {
+          "id": 1000,
+          "name": "",
+          "code": "DEMO_REQUESTED",
+          "editable": "N"
+        },
+        {
+          "id": 1001,
+          "name": "",
+          "code": "BILL_CREATED",
+          "editable": "N"
+        }
+      ],
+      "task_types": [
+        {
+          "id": 1,
+          "name": "Звонок",
+          "code": "CALL"
+        },
+        {
+          "id": 2,
+          "name": "Встреча",
+          "code": "MEETING"
+        }
+      ],
+      "timezoneoffset": "+03:00"
+    },
+    "server_time": 1422442143
+  }
+}

data/spec/helpers/webmock_helpers.rb

@@ -9,6 +9,16 @@ module AmoWebMock
     account_info_stub(Amorail.config.api_endpoint)
   end
 
+  def mock_custom_api(endpoint, usermail, api_key, properties = 'account2_response.json')
+    authorize_stub(
+      endpoint,
+      usermail,
+      api_key
+    )
+
+    account_info_stub(endpoint, properties)
+  end
+
   def authorize_stub(endpoint, usermail, api_key)
     cookie = 'PHPSESSID=58vorte6dd4t7h6mtuig9l0p50; path=/; domain=amocrm.ru'
     stub_request(:post, "#{endpoint}/private/api/auth.php?type=json")
@@ -23,10 +33,10 @@ module AmoWebMock
         })
   end
 
-  def account_info_stub(endpoint)
+  def account_info_stub(endpoint, properties = 'account_response.json')
     stub_request(:get, endpoint + '/private/api/v2/json/accounts/current')
       .to_return(
-        body: File.read('./spec/fixtures/account_response.json'),
+        body: File.read("./spec/fixtures/#{properties}"),
         headers: { 'Content-Type' => 'application/json' },
         status: 200
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amorail
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alekseenkoss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,16 +43,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +211,7 @@ files:
 - spec/contact_link_spec.rb
 - spec/contact_spec.rb
 - spec/entity_spec.rb
+- spec/fixtures/account2_response.json
 - spec/fixtures/account_response.json
 - spec/fixtures/amorail_test.yml
 - spec/fixtures/contact_create.json
@@ -251,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby API client for AmoCRM
@@ -261,6 +262,7 @@ test_files:
 - spec/contact_link_spec.rb
 - spec/contact_spec.rb
 - spec/entity_spec.rb
+- spec/fixtures/account2_response.json
 - spec/fixtures/account_response.json
 - spec/fixtures/amorail_test.yml
 - spec/fixtures/contact_create.json
@@ -281,4 +283,3 @@ test_files:
 - spec/support/my_contact.rb
 - spec/support/my_entity.rb
 - spec/task_spec.rb
-has_rdoc: