amorail 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42a2851b1c9adb5f49a331d622c3fd276c63761b
-  data.tar.gz: 8012dce427d24125bfeb3a10059033c577bcbd5b
+SHA256:
+  metadata.gz: f65fb80eb5f426c50e32fa474252e764e42e3887cddbf7f735ad217ad98560cf
+  data.tar.gz: 5f44b5e558be01b346ad68d4d84c903deec88e05514430531b6aa0b6e02c3e73
 SHA512:
-  metadata.gz: a102ba6296a1e3ed6ab4f2c4160415429f351398e83240d0d2453a72c6302eefaf83c42624b43f037e00fb7dbc40f669f37ea27bd32d6311fe5d250a5b0dc248
-  data.tar.gz: b7214099abe616f5902717c4f823cabab5e818e84752cf649330cf70191c8b0b6488495f1b4e26fd7afcc27c5712d2431ef728356daefd5fd53a6d03b6b3af2b
+  metadata.gz: 14958c70d64dda63dd82c334d08b2c63cbe8183fbffc8b5c5a63893e42280b0439e8eef4411b9b222c52e54d7dfa0949e82061de6feb4b3814ad169d5ab37cc6
+  data.tar.gz: a370262be82cdde926d639976fea7e23833a6f999cff3100c2a5df57e9962c8ea05b5e6b682e4d2738b4f322a3cba73d81195e721eefe017e8717c103a665f2e

data/.rubocop.yml

@@ -56,3 +56,6 @@ Style/SignalException:
 
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false

data/lib/amorail/entities/contact.rb

@@ -22,6 +22,7 @@ module Amorail
 
     def company
       return if linked_company_id.nil?
+
       @company ||= Amorail::Company.find(linked_company_id)
     end
   end

data/lib/amorail/entities/lead.rb

@@ -15,6 +15,7 @@ module Amorail
     # Return list of associated contacts
     def contacts
       fail NotPersisted if id.nil?
+
       @contacts ||=
         begin
           links = Amorail::ContactLink.find_by_leads(id)

data/lib/amorail/entities/leadable.rb

@@ -22,6 +22,7 @@ module Amorail
     # Return all linked leads
     def leads
       return [] if linked_leads_id.empty?
+
       @leads ||= Amorail::Lead.find_all(linked_leads_id)
     end
   end

data/lib/amorail/entities/webhook.rb

@@ -0,0 +1,42 @@
+module Amorail
+  # AmoCRM webhook entity
+  class Webhook < Entity
+    amo_names 'webhooks'
+
+    amo_field :id, :url, :events, :disabled
+
+    def self.list
+      response = client.safe_request(:get, remote_url('list'))
+
+      return [] if response.body.blank?
+
+      response.body['response'].fetch(amo_response_name, []).map do |attributes|
+        new.reload_model(attributes)
+      end
+    end
+
+    def self.subscribe(webhooks)
+      perform_webhooks_request('subscribe', webhooks) do |data|
+        data.map { |attrs| new.reload_model(attrs) }
+      end
+    end
+
+    def self.unsubscribe(webhooks)
+      perform_webhooks_request('unsubscribe', webhooks)
+    end
+
+    def self.perform_webhooks_request(action, webhooks, &block)
+      response = client.safe_request(
+        :post,
+        remote_url(action),
+        request: { webhooks: { action => webhooks } }
+      )
+
+      return response unless block
+
+      block.call(response.body['response'].dig(amo_response_name, 'subscribe'))
+    end
+
+    private_class_method :perform_webhooks_request
+  end
+end

data/lib/amorail/entity.rb

@@ -77,6 +77,7 @@ module Amorail
       attrs.each do |k, v|
         action = "#{k}="
         next unless respond_to?(action)
+
         send(action, v)
       end
       self
@@ -84,9 +85,11 @@ module Amorail
 
     def merge_custom_fields(fields)
       return if fields.nil?
+
       fields.each do |f|
         fname = f['code'] || f['name']
         next if fname.nil?
+
         fname = "#{fname.downcase}="
         fval = f.fetch('values').first.fetch('value')
         send(fname, fval) if respond_to?(fname)
@@ -119,7 +122,7 @@ module Amorail
       )
       reload_model(data)
     rescue InvalidRecord
-      return false
+      false
     end
   end
 end

data/lib/amorail/entity/finders.rb

@@ -11,6 +11,7 @@ module Amorail # :nodoc: all
       def find!(id)
         rec = find(id)
         fail RecordNotFound unless rec
+
         rec
       end
 
@@ -32,8 +33,8 @@ module Amorail # :nodoc: all
 
       # Find AMO entities by query
       # Returns array of matching entities.
-      def find_by_query(q)
-        where(query: q)
+      def find_by_query(query)
+        where(query: query)
       end
 
       private

data/lib/amorail/entity/persistence.rb

@@ -13,6 +13,7 @@ module Amorail # :nodoc: all
 
     def save
       return false unless valid?
+
       new_record? ? push('add') : push('update')
     end
 
@@ -22,6 +23,7 @@ module Amorail # :nodoc: all
 
     def update(attrs = {})
       return false if new_record?
+
       merge_params(attrs)
       push('update')
     end
@@ -32,6 +34,7 @@ module Amorail # :nodoc: all
 
     def reload
       fail NotPersisted if id.nil?
+
       load_record(id)
     end
 

data/lib/amorail/property.rb

@@ -26,6 +26,7 @@ module Amorail
           data['custom_fields'].fetch(source_name, []).each do |contact|
             identifier = contact['code'].presence || contact['name'].presence
             next if identifier.nil?
+
             hash[identifier.downcase] = PropertyItem.new(contact)
           end
           new hash
@@ -118,6 +119,7 @@ module Amorail
           prop_item = PropertyItem.new(tt)
           identifier = tt['code'].presence || tt['name'].presence
           next if identifier.nil?
+
           hash[identifier.downcase] = prop_item
           hash[identifier] = prop_item
         end

data/lib/amorail/railtie.rb

@@ -2,7 +2,7 @@ module Amorail
   # Add amorail rake tasks
   class Railtie < Rails::Railtie
     rake_tasks do
-      load File.expand_path('../../tasks/amorail.rake', __FILE__)
+      load File.expand_path('../tasks/amorail.rake', __dir__)
     end
   end
 end

data/lib/amorail/version.rb

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

data/spec/fixtures/webhooks/list.json

@@ -0,0 +1,24 @@
+{
+  "response": {
+    "webhooks": [
+      {
+        "id": "1",
+        "url": "http://example.org",
+        "events": [
+          "add_contact"
+        ],
+        "disabled": false
+      },
+      {
+        "id": "2",
+        "url": "http://example.com",
+        "events": [
+          "add_contact",
+					"add_company"
+        ],
+        "disabled": true
+      }
+    ],
+    "server_time": 1539938502
+  }
+}

data/spec/fixtures/webhooks/subscribe.json

@@ -0,0 +1,17 @@
+{
+  "response": {
+    "webhooks": {
+      "subscribe": [
+        {
+          "url": "http://example.org",
+          "result": true
+        },
+        {
+          "url": "http://example.com",
+          "result": true
+        }
+      ]
+    },
+    "server_time": 1539941636
+  }
+}

data/spec/fixtures/webhooks/unsubscribe.json

@@ -0,0 +1,17 @@
+{
+  "response": {
+    "webhooks": {
+      "unsubscribe": [
+        {
+          "url": "http://example.org",
+          "result": true
+        },
+        {
+          "url": "http://example.com",
+          "result": true
+        }
+      ]
+    },
+    "server_time": 1539941911
+  }
+}

data/spec/helpers/webmock_helpers.rb

@@ -246,4 +246,34 @@ module AmoWebMock
         .to_return(status: 204)
     end
   end
+
+  def webhooks_list_stub(endpoint, empty: false)
+    body = empty ? '' : File.read('./spec/fixtures/webhooks/list.json')
+    stub_request(:get, "#{endpoint}/private/api/v2/json/webhooks/list")
+      .to_return(
+        body: body,
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
+
+  def webhooks_subscribe_stub(endpoint, webhooks)
+    stub_request(:post, "#{endpoint}/private/api/v2/json/webhooks/subscribe")
+      .with(body: { request: { webhooks: { subscribe: webhooks } } }.to_json)
+      .to_return(
+        body: File.read('./spec/fixtures/webhooks/subscribe.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
+
+  def webhooks_unsubscribe_stub(endpoint, webhooks)
+    stub_request(:post, "#{endpoint}/private/api/v2/json/webhooks/unsubscribe")
+      .with(body: { request: { webhooks: { unsubscribe: webhooks } } }.to_json)
+      .to_return(
+        body: File.read('./spec/fixtures/webhooks/unsubscribe.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
 end

data/spec/spec_helper.rb

@@ -10,9 +10,9 @@ require 'helpers/webmock_helpers'
 
 # Cleanup Amorail env
 ENV.delete_if { |k, _| k =~ /amorail/i }
-ENV["AMORAIL_CONF"] = File.expand_path("../fixtures/amorail_test.yml", __FILE__)
+ENV["AMORAIL_CONF"] = File.expand_path("fixtures/amorail_test.yml", __dir__)
 
-Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |f| require f }
 
 RSpec.configure do |config|
   config.mock_with :rspec

data/spec/webhook_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Amorail::Webhook do
+  before { mock_api }
+
+  describe '.list' do
+    context 'there are some webhooks' do
+      before { webhooks_list_stub(Amorail.config.api_endpoint) }
+
+      it 'loads webhooks' do
+        res = described_class.list
+        expect(res.size).to eq 2
+        expect(res.first.id).to eq '1'
+        expect(res.first.url).to eq 'http://example.org'
+        expect(res.first.events).to eq ['add_contact']
+        expect(res.first.disabled).to eq false
+        expect(res.last.id).to eq '2'
+        expect(res.last.url).to eq 'http://example.com'
+        expect(res.last.events).to eq ['add_contact', 'add_company']
+        expect(res.last.disabled).to eq true
+      end
+    end
+
+    context 'there are not any webhooks' do
+      before { webhooks_list_stub(Amorail.config.api_endpoint, empty: true) }
+
+      it 'returns an empty array' do
+        res = described_class.list
+        expect(res).to eq []
+      end
+    end
+  end
+
+  describe '.subscribe' do
+    it 'creates webhooks' do
+      webhooks = [
+        { url: 'http://example.org', events: ['add_contact'] },
+        { url: 'http://example.com', events: ['add_contact', 'add_company'] }
+      ]
+      stub = webhooks_subscribe_stub(Amorail.config.api_endpoint, webhooks)
+      res = described_class.subscribe(webhooks)
+      expect(stub).to have_been_requested
+      expect(res.first.url).to eq 'http://example.org'
+      expect(res.last.url).to eq 'http://example.com'
+    end
+  end
+
+  describe '.unsubscribe' do
+    it 'removes webhooks' do
+      webhooks = [
+        { url: 'http://example.org', events: ['add_contact'] },
+        { url: 'http://example.com', events: ['add_contact', 'add_company'] }
+      ]
+      stub = webhooks_unsubscribe_stub(Amorail.config.api_endpoint, webhooks)
+      described_class.unsubscribe(webhooks)
+      expect(stub).to have_been_requested
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amorail
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - alekseenkoss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,6 +212,7 @@ files:
 - lib/amorail/entities/leadable.rb
 - lib/amorail/entities/note.rb
 - lib/amorail/entities/task.rb
+- lib/amorail/entities/webhook.rb
 - lib/amorail/entity.rb
 - lib/amorail/entity/finders.rb
 - lib/amorail/entity/params.rb
@@ -240,6 +241,9 @@ files:
 - spec/fixtures/leads/links.json
 - spec/fixtures/leads/update.json
 - spec/fixtures/leads/update_errors.json
+- spec/fixtures/webhooks/list.json
+- spec/fixtures/webhooks/subscribe.json
+- spec/fixtures/webhooks/unsubscribe.json
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb
 - spec/my_contact_spec.rb
@@ -252,6 +256,7 @@ files:
 - spec/support/my_contact.rb
 - spec/support/my_entity.rb
 - spec/task_spec.rb
+- spec/webhook_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -272,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby API client for AmoCRM
@@ -296,6 +301,9 @@ test_files:
 - spec/fixtures/leads/links.json
 - spec/fixtures/leads/update.json
 - spec/fixtures/leads/update_errors.json
+- spec/fixtures/webhooks/list.json
+- spec/fixtures/webhooks/subscribe.json
+- spec/fixtures/webhooks/unsubscribe.json
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb
 - spec/my_contact_spec.rb
@@ -308,3 +316,4 @@ test_files:
 - spec/support/my_contact.rb
 - spec/support/my_entity.rb
 - spec/task_spec.rb
+- spec/webhook_spec.rb