amorail 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a8ca62be5f80149cddb2e7e82442d611b9fe32
-  data.tar.gz: 90ce153c4740de2c2049adcc2f473f6f1b0d9b57
+  metadata.gz: 6a49cf3e73052b401ec558f46cf546671cefd4ba
+  data.tar.gz: 05204059536051197800da4bd8f784c9dd13b0d2
 SHA512:
-  metadata.gz: c0d2b86bbfef3d13494baffbe381ccf0e4ce4162100cecb37c92a301324c4d87fd7295a2873ba58ed04a1f3c8acadc34b2d281b6d887a9cb810328702617e418
-  data.tar.gz: d8718c7c448a91b45be58d25ae26970c8c4b222c0dbee8682223548eb00df93fdaba99a340c508e961517b34ee1f026916c598dceecb74b933b97ccf051da95c
+  metadata.gz: ecdea4ff97ea0018b2b25cce5e049fef9fb8c7ecea9fffe88777f4b25fa0b98378233d8ef3abbd4adf27c29d8ceee205621339e2db4d3697392ea375e63ee484
+  data.tar.gz: 24379dc6fc1498860dadda55c13ebacf7bba1ccab4b9a058aad304eb22dbd2d64e7d10386e23f3f1d14912b11830c5dd23cd0c62f274f8e7f361a46ccb511cc7

data/.rubocop.yml

@@ -30,3 +30,14 @@ Rails/Date:
 
 Rails/TimeZone:
   Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/WordArray:
+  Enabled: false

data/README.md

@@ -143,6 +143,57 @@ contact.save!
 contact.update(linked_company_id: company.id)
 ```
 
+### Querying
+
+Load by id
+
+```ruby
+Amorail::Contact.find(223) #=> #<Amorail::Contact ...>
+```
+
+Load many entites by array of ids
+
+```ruby
+Amorail::Contact.find_all(123, 124) #=> [#<Amorail::Contact ...>, ...]
+```
+
+Load by query
+
+```ruby
+Amorail::Contact.find_by_query("my_company") #=> [#<Amorail::Contact ...>, ...]
+```
+
+
+Load contacts associated with lead
+
+```ruby
+lead = Amorail::Lead.find(1)
+lead.contacts #=> [#<Amorail::Contact ...>, ...]
+```
+
+Load company associated with contact
+
+```ruby
+contact = Amorail::Contact.find(1)
+contact.company #=> #<Amorail::Company ...>
+```
+
+Load leads associated with contact
+
+```ruby
+contact = Amorail::Contact.find(1)
+contact.leads #=> [#<Amorail::Lead ...>, ...]
+```
+
+Load contacts-leads pairs
+
+```ruby
+# Load all contact-leads pairs for contacts
+Amorail::ContactLink.find_by_contacts(1, 2)
+
+# Load all contact-leads pairs for leads
+Amorail::ContactLink.find_by_leads(1, 2)
+```
 
 ### Properties Configuration
 

data/lib/amorail/entities/contact.rb

@@ -14,6 +14,12 @@ module Amorail
 
     validates :name, presence: true
 
+    # Clear company cache
+    def reload
+      @company = nil
+      super
+    end
+
     def company
       return if linked_company_id.nil?
       @company ||= Amorail::Company.find(linked_company_id)

data/lib/amorail/entities/contact_link.rb

@@ -0,0 +1,32 @@
+module Amorail
+  # AmoCRM contact-link join model
+  class ContactLink < Amorail::Entity
+    amo_names "contacts", "links"
+
+    amo_field :contact_id, :lead_id
+
+    class << self
+      # 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(
+          :get,
+          remote_url('links'),
+          contacts_link: ids
+        )
+        load_many(response)
+      end
+
+      # 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(
+          :get,
+          remote_url('links'),
+          deals_link: ids
+        )
+        load_many(response)
+      end
+    end
+  end
+end

data/lib/amorail/entities/lead.rb

@@ -6,5 +6,20 @@ module Amorail
     amo_field :name, :price, :status_id, :tags
 
     validates :name, :status_id, presence: true
+
+    def reload
+      @contacts = nil
+      super
+    end
+
+    # Return list of associated contacts
+    def contacts
+      fail NotPersisted if id.nil?
+      @contacts ||=
+        begin
+          links = Amorail::ContactLink.find_by_leads(id)
+          links.empty? ? [] : Amorail::Contact.find_all(links.map(&:contact_id))
+        end
+    end
   end
 end

data/lib/amorail/entities/leadable.rb

@@ -1,14 +1,28 @@
 module Amorail
   # Lead associations
   module Leadable
-    def linked_leads_id
-      @linked_leads_id ||= []
+    extend ActiveSupport::Concern
+
+    included do
+      amo_field :linked_leads_id
+    end
+
+    # Set initial value for linked_leads_id to []
+    def initialize(*args)
+      super
+      self.linked_leads_id ||= []
+    end
+
+    # Clear leads cache on reload
+    def reload
+      @leads = nil
+      super
     end
 
-    def params
-      data = super
-      data[:linked_leads_id] = linked_leads_id unless linked_leads_id.empty?
-      data
+    # Return all linked leads
+    def leads
+      return [] if linked_leads_id.empty?
+      @leads ||= Amorail::Lead.find_all(linked_leads_id)
     end
   end
 end

data/lib/amorail/entity/finders.rb

@@ -14,6 +14,17 @@ module Amorail # :nodoc: all
         rec
       end
 
+      def find_all(*ids)
+        ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
+
+        response = Amorail.client.safe_request(
+          :get,
+          remote_url('list'),
+          id: ids
+        )
+        load_many(response)
+      end
+
       # Find AMO entities by query
       # Returns array of matching entities.
       def find_by_query(q)
@@ -22,6 +33,12 @@ module Amorail # :nodoc: all
           remote_url('list'),
           query: q
         )
+        load_many(response)
+      end
+
+      private
+
+      def load_many(response)
         return [] unless response.status == 200
 
         (response.body['response'][amo_response_name] || [])

data/lib/amorail/version.rb

@@ -1,4 +1,4 @@
 # Amorail version
 module Amorail
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/spec/contact_link_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Amorail::ContactLink do
+  before { mock_api }
+
+  describe ".attributes" do
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify do
+      is_expected.to include(
+        :contact_id,
+        :lead_id
+      )
+    end
+  end
+
+  describe ".find_by_leads" do
+    before { leads_links_stub(Amorail.config.api_endpoint, [2]) }
+
+    it "returns list of contact links" do
+      res = described_class.find_by_leads(2)
+      expect(res.size).to eq 2
+      expect(res.first.contact_id).to eq "101"
+      expect(res.last.contact_id).to eq "102"
+    end
+  end
+
+  describe ".find_by_contacts" do
+    before { contacts_links_stub(Amorail.config.api_endpoint, [101]) }
+
+    it "returns list of contact links" do
+      res = described_class.find_by_contacts(101)
+      expect(res.size).to eq 2
+      expect(res.first.lead_id).to eq "1"
+      expect(res.last.lead_id).to eq "2"
+    end
+  end
+end

data/spec/contact_spec.rb

@@ -78,6 +78,7 @@ describe Amorail::Contact do
       expect(obj.email).to eq "foo@tb.com"
       expect(obj.phone).to eq "1111 111 111"
       expect(obj.params[:id]).to eq 101
+      expect(obj.linked_leads_id).to contain_exactly("1872746", "1885024")
     end
 
     it "returns nil" do
@@ -113,6 +114,28 @@ describe Amorail::Contact do
     end
   end
 
+  describe ".find_all" do
+    before { contacts_find_all_stub(Amorail.config.api_endpoint, [101, 102]) }
+    before { contacts_find_all_stub(Amorail.config.api_endpoint, [105, 104], false) }
+
+    it "loads entities" do
+      res = described_class.find_all(101, 102)
+      expect(res.size).to eq 2
+      expect(res.first.id).to eq 101
+      expect(res.last.id).to eq 102
+      expect(res.first.company_name).to eq "Foo Inc."
+      expect(res.last.email).to eq "foo2@tb.com"
+      expect(res.first.phone).to eq "1111 111 111"
+      expect(res.first.params[:id]).to eq 101
+    end
+
+    it "returns empty array" do
+      res = described_class.find_all([105, 104])
+      expect(res).to be_a(Array)
+      expect(res).to be_empty
+    end
+  end
+
   describe "#save" do
     before { contact_create_stub(Amorail.config.api_endpoint) }
 

data/spec/fixtures/contact_find.json

@@ -7,6 +7,10 @@
         "account_id": "8195968",
         "last_modified": 1423139130,
         "company_name": "Foo Inc.",
+        "linked_leads_id":  [
+           "1872746",
+           "1885024"
+        ],
         "custom_fields": 
         [
           {

data/spec/fixtures/contacts_links.json

@@ -0,0 +1,15 @@
+{
+"response":  {
+  "links":  [
+  {
+    "contact_id":  "101",
+    "lead_id":  "1",
+     "last_modified":  1374741830
+  },
+  {
+    "contact_id":  "101",
+    "lead_id":  "2",
+    "last_modified":  1374839942
+  }]
+}
+}

data/spec/fixtures/leads.json

@@ -0,0 +1,69 @@
+{
+"response":  {
+  "leads":  [
+  {
+    "id":  "1",
+    "name":  "Research new technologies",
+    "last_modified":  1374656336,
+    "status_id":  "7046196",
+    "price":  "500000",
+    "responsible_user_id":  "103586",
+    "tags":[
+      {
+       "id":  "960472",
+       "name":  "USA"},
+      {
+       "id":  "960854",
+       "name":  "Lead"
+      }
+    ],
+    "date_create": 1386014400,
+    "account_id":  "7046192",
+    "created_user_id": "4502311",
+    "custom_fields":  [
+      {
+      "id":  "484604",
+      "name":  "field",
+      "values":  [
+        {
+          "value":  "text"
+        }
+      ]
+    }
+    ]
+  },
+  {
+    "id":  "2",
+    "name":  "Sell it!",
+    "last_modified":  1374656336,
+    "status_id":  "7046196",
+    "price":  "100000",
+    "responsible_user_id":  "103586",
+    "tags":[
+      {
+       "id":  "960472",
+       "name":  "USA"},
+      {
+       "id":  "960854",
+       "name":  "Lead"
+      }
+    ],
+    "date_create": 1386014400,
+    "account_id":  "7046192",
+    "created_user_id": "4502311",
+    "custom_fields":  [
+      {
+      "id":  "484604",
+      "name":  "field",
+      "values":  [
+        {
+          "value":  "text"
+        }
+      ]
+    }
+    ]
+  }
+  ],
+  "server_time":  1374839787
+  }
+}

data/spec/fixtures/leads_links.json

@@ -0,0 +1,15 @@
+{
+"response":  {
+  "links":  [
+  {
+    "contact_id":  "101",
+    "lead_id":  "2",
+    "last_modified":  1374839942
+  },
+  {
+    "contact_id":  "102",
+    "lead_id":  "2",
+    "last_modified":  1374839942
+  }]
+}
+}

data/spec/helpers/webmock_helpers.rb

@@ -122,6 +122,24 @@ module AmoWebMock
     end
   end
 
+  def contacts_find_all_stub(endpoint, ids, success = true)
+    if success
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/contacts/list?#{ids.to_query('id')}")
+        .to_return(
+          body: File.read('./spec/fixtures/contact_find_query.json'),
+          headers: { 'Content-Type' => 'application/json' },
+          status: 200
+        )
+    else
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/contacts/list?#{ids.to_query('id')}")
+        .to_return(status: 204)
+    end
+  end
+
   def company_create_stub(endpoint)
     stub_request(:post, endpoint + '/private/api/v2/json/company/set')
       .to_return(
@@ -130,4 +148,45 @@ module AmoWebMock
         status: 200
       )
   end
+
+  def leads_stub(endpoint, ids, success = true)
+    if success
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/leads/list?#{ids.to_query('id')}")
+        .to_return(
+          body: File.read('./spec/fixtures/leads.json'),
+          headers: { 'Content-Type' => 'application/json' },
+          status: 200
+        )
+    else
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/leads/list?#{ids.to_query('id')}")
+        .to_return(status: 204)
+    end
+  end
+
+  def contacts_links_stub(endpoint, ids)
+    stub_request(:get, endpoint + "/private/api/v2/json/contacts/links?#{ids.to_query('contacts_link')}")
+      .to_return(
+        body: File.read('./spec/fixtures/contacts_links.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
+
+  def leads_links_stub(endpoint, ids, success = true)
+    if success
+      stub_request(:get, endpoint + "/private/api/v2/json/contacts/links?#{ids.to_query('deals_link')}")
+        .to_return(
+          body: File.read('./spec/fixtures/leads_links.json'),
+          headers: { 'Content-Type' => 'application/json' },
+          status: 200
+        )
+    else
+      stub_request(:get, endpoint + "/private/api/v2/json/contacts/links?#{ids.to_query('deals_link')}")
+        .to_return(status: 204)
+    end
+  end
 end

data/spec/lead_spec.rb

@@ -41,4 +41,33 @@ describe Amorail::Lead do
     specify { is_expected.to include(status_id: 2) }
     specify { is_expected.to include(tags: 'test lead') }
   end
+
+  describe "#contacts" do
+    let(:lead) { described_class.new(id: 2) }
+
+    it "fails if not persisted" do
+      expect { described_class.new.contacts }
+        .to raise_error(Amorail::Entity::NotPersisted)
+    end
+
+    context "has contacts" do
+      before { leads_links_stub(Amorail.config.api_endpoint, [2]) }
+      before { contacts_find_all_stub(Amorail.config.api_endpoint, [101, 102]) }
+
+      it "loads contacts for lead" do
+        res = lead.contacts
+        expect(res.size).to eq 2
+        expect(res.first.id).to eq 101
+        expect(res.last.id).to eq 102
+      end
+    end
+
+    context "no contacts" do
+      before { leads_links_stub(Amorail.config.api_endpoint, [2], false) }
+
+      it "returns empty" do
+        expect(lead.contacts).to be_empty
+      end
+    end
+  end
 end

data/spec/support/leadable_example.rb

@@ -11,4 +11,23 @@ shared_examples 'leadable' do
     specify { is_expected.to include(:linked_leads_id) }
     specify { expect(subject.fetch(:linked_leads_id)).to include(100) }
   end
+
+  describe "#leads" do
+    before { leads_stub(Amorail.config.api_endpoint, [1, 2]) }
+
+    let(:leadable) { described_class.new(linked_leads_id: ['1', '2']) }
+
+    it "loads leads" do
+      expect(leadable.leads.size).to eq 2
+      expect(leadable.leads.first).to be_a(Amorail::Lead)
+      expect(leadable.leads.first.name).to eq "Research new technologies"
+    end
+
+    it "cache results" do
+      url = URI.join(Amorail.config.api_endpoint, Amorail::Lead.remote_url('list'))
+      leadable.leads
+      leadable.leads
+      expect(WebMock).to have_requested(:get, url).with(query: { id: [1, 2] }).once
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amorail
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - alekseenkoss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,6 +194,7 @@ files:
 - lib/amorail/engine.rb
 - lib/amorail/entities/company.rb
 - lib/amorail/entities/contact.rb
+- lib/amorail/entities/contact_link.rb
 - lib/amorail/entities/lead.rb
 - lib/amorail/entities/leadable.rb
 - lib/amorail/entities/task.rb
@@ -207,6 +208,7 @@ files:
 - lib/tasks/amorail.rake
 - spec/client_spec.rb
 - spec/company_spec.rb
+- spec/contact_link_spec.rb
 - spec/contact_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/account_response.json
@@ -215,6 +217,9 @@ files:
 - spec/fixtures/contact_find.json
 - spec/fixtures/contact_find_query.json
 - spec/fixtures/contact_update.json
+- spec/fixtures/contacts_links.json
+- spec/fixtures/leads.json
+- spec/fixtures/leads_links.json
 - spec/fixtures/my_contact_find.json
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb
@@ -253,6 +258,7 @@ summary: Ruby API client for AmoCRM
 test_files:
 - spec/client_spec.rb
 - spec/company_spec.rb
+- spec/contact_link_spec.rb
 - spec/contact_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/account_response.json
@@ -261,6 +267,9 @@ test_files:
 - spec/fixtures/contact_find.json
 - spec/fixtures/contact_find_query.json
 - spec/fixtures/contact_update.json
+- spec/fixtures/contacts_links.json
+- spec/fixtures/leads.json
+- spec/fixtures/leads_links.json
 - spec/fixtures/my_contact_find.json
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb