amorail 0.3.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8db673fd4edfbf45eb53a5d0f975a89d7895fdba
-  data.tar.gz: 356888cd7462e7c1ec8c0b427f422faf6b2da05e
+SHA256:
+  metadata.gz: 6047ec19aa4839d30b29fc1cb9ee38079a04812b2ed6547d2e24e1e8ed16a57d
+  data.tar.gz: 64bfbcd2f8574b70c420a274bd8707533b4f4334020d180fda7acb85cdcee509
 SHA512:
-  metadata.gz: 97c770c6157118cb4613528c1b0f3ce57f958bb973426b3113bf5c5ee0f7da40d197dc516401568ca0fcc615764484de9936e3ff8f82df2d0c4f59dd406aacd2
-  data.tar.gz: 965e56642519d357ba3eba530bfdd1a8b1f967bb0d8e11ab0dc54ccab032ef82ae40c97a91c0ed396f4cd3a19e72f8a796ea306afae7513616cc0023422fcb64
+  metadata.gz: 55fc29183cff4df2db947a76ceae748d289ebab1f1e88310e7c13234dd75886c87e9f68c41b782ba251be69f2226f386501974108ce2cc00fdc656e1ccdfe059
+  data.tar.gz: da64fc02f0bc506319bd543e7b35cb5dfdd3b112cc04458f25904c5d9ece1bc38df8d659ca1d705e17fcea8e7cd82e954c7f4642048fb2ed627a03c0f1802b8c

data/.rubocop.yml

@@ -6,7 +6,9 @@ AllCops:
     - 'spec/**/*.rb'
   Exclude:
     - 'bin/**/*'
-  RunRailsCops: true
+    - Rakefile
+    - Gemfile
+    - '*.gemspec'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
 
@@ -39,5 +41,21 @@ Metrics/LineLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
 Style/WordArray:
   Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/teachbase/amorail.svg?branch=master)](https://travis-ci.org/teachbase/amorail)
+[![Gem Version](https://badge.fury.io/rb/amorail.svg)](https://rubygems.org/gems/amorail) [![Build Status](https://travis-ci.org/teachbase/amorail.svg?branch=master)](https://travis-ci.org/teachbase/amorail)
 
 # Amorail
 
@@ -128,6 +128,12 @@ Or using query:
   Amorail::Company.find_by_query("vip")
 ```
 
+Or using arbitrary params:
+
+```ruby
+  Amorail::Company.where(query: "test", limit_rows: 10)
+```
+
 Also you can update objects, e.g:
 
 ```ruby

data/Rakefile

@@ -1,11 +1,15 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-Dir.glob('lib/tasks/*.rake').each {|r| import r}
+require "rubocop/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
 
 task :console do
   sh 'pry -r ./lib/amorail.rb'
 end
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/amorail.gemspec

@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   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"
-  spec.add_dependency "anyway_config", "~> 0", ">= 0.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.0"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_dependency "anyway_config", ">= 1.0"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
   spec.add_dependency 'activemodel'

data/lib/amorail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'amorail/version'
 require 'amorail/config'
 require 'amorail/client'
@@ -35,6 +37,7 @@ module Amorail
     client = Client.new(client) unless client.is_a?(Client)
     ClientRegistry.client = client
     yield
+  ensure
     ClientRegistry.client = nil
   end
 

data/lib/amorail/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
@@ -6,6 +8,8 @@ require 'active_support'
 module Amorail
   # Amorail http client
   class Client
+    SUCCESS_STATUS_CODES = [200, 204].freeze
+
     attr_reader :usermail, :api_key, :api_endpoint
 
     def initialize(api_endpoint: Amorail.config.api_endpoint,
@@ -15,9 +19,9 @@ module Amorail
       @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
+        faraday.adapter Faraday.default_adapter
       end
     end
 
@@ -41,10 +45,10 @@ module Amorail
     end
 
     def safe_request(method, url, params = {})
-      send(method, url, params)
+      public_send(method, url, params)
     rescue ::Amorail::AmoUnauthorizedError
       authorize
-      send(method, url, params)
+      public_send(method, url, params)
     end
 
     def get(url, params = {})
@@ -72,7 +76,7 @@ module Amorail
     end
 
     def handle_response(response) # rubocop:disable all
-      return response if response.status == 200 || response.status == 204
+      return response if SUCCESS_STATUS_CODES.include?(response.status)
 
       case response.status
       when 301

data/lib/amorail/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'anyway'
 
 module Amorail

data/lib/amorail/entities/company.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'amorail/entities/leadable'
 
 module Amorail

data/lib/amorail/entities/contact.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'amorail/entities/leadable'
 
 module Amorail
@@ -22,6 +24,7 @@ module Amorail
 
     def company
       return if linked_company_id.nil?
+
       @company ||= Amorail::Company.find(linked_company_id)
     end
   end

data/lib/amorail/entities/contact_link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amorail
   # AmoCRM contact-link join model
   class ContactLink < Amorail::Entity

data/lib/amorail/entities/elementable.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Amorail
+  # Provides common functionallity for entities
+  # that can be attached to another objects.
+  module Elementable
+    extend ActiveSupport::Concern
+
+    ELEMENT_TYPES = {
+      contact: 1,
+      lead: 2,
+      company: 3,
+      task: 4
+    }.freeze
+
+    included do
+      amo_field :element_id, :element_type
+
+      validates :element_id, :element_type,
+                presence: true
+    end
+
+    ELEMENT_TYPES.each do |type, value|
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{type}=(val)                        # def contact=(val)
+          #{type}! if val                        #   contact! if val
+        end                                      # end
+
+        def #{type}?                             # def contact?
+          self.element_type == #{value}          #   self.element_type == 1
+        end                                      # end
+
+        def #{type}!                             # def contact!
+          self.element_type = #{value}           #   self.element_type = 1
+        end                                      # end
+      CODE
+    end
+  end
+end

data/lib/amorail/entities/lead.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Amorail
   # AmoCRM lead entity
   class Lead < Amorail::Entity
     amo_names "leads"
 
-    amo_field :name, :price, :status_id, :tags
+    amo_field :name, :price, :status_id, :pipeline_id, :tags
 
     validates :name, :status_id, presence: true
 
@@ -15,6 +17,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amorail
   # Lead associations
   module Leadable
@@ -22,6 +24,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/note.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'amorail/entities/elementable'
+
+module Amorail
+  # AmoCRM note entity
+  class Note < Amorail::Entity
+    include Elementable
+
+    amo_names 'notes'
+
+    amo_field :note_type, :text
+
+    validates :note_type, :text,
+              presence: true
+
+    validates :element_type, inclusion: ELEMENT_TYPES.values
+  end
+end

data/lib/amorail/entities/task.rb

@@ -1,32 +1,20 @@
+# frozen_string_literal: true
+
+require 'amorail/entities/elementable'
+
 module Amorail
   # AmoCRM task entity
   class Task < Amorail::Entity
-    amo_names "tasks"
-
-    amo_field :element_id, :element_type, :text,
-              :task_type, complete_till: :timestamp
+    include Elementable
 
-    validates :text, :element_id,
-              :element_type, :complete_till,
-              :task_type,
-              presence: true
-
-    validates :element_type, inclusion: 1..2
+    amo_names 'tasks'
 
-    [{ name: "contact", val: 1 }, { name: "lead", val: 2 }].each do |prop|
-      class_eval <<-CODE, __FILE__, __LINE__ + 1
-        def #{prop[:name]}=(val)
-          #{prop[:name]}! if val
-        end
+    amo_field :task_type, :text, complete_till: :timestamp
 
-        def #{prop[:name]}?
-          self.element_type == #{prop[:val]}
-        end
+    validates :task_type, :text, :complete_till,
+              presence: true
 
-        def #{prop[:name]}!
-          self.element_type = #{prop[:val]}
-        end
-      CODE
-    end
+    validates :element_type, inclusion:
+              ELEMENT_TYPES.reject { |type, _| type == :task }.values
   end
 end

data/lib/amorail/entities/webhook.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 
 module Amorail
@@ -62,7 +64,7 @@ module Amorail
     end
 
     require 'amorail/entity/params'
-    require 'amorail/entity/persistance'
+    require 'amorail/entity/persistence'
     require 'amorail/entity/finders'
 
     def reload_model(info)
@@ -77,6 +79,7 @@ module Amorail
       attrs.each do |k, v|
         action = "#{k}="
         next unless respond_to?(action)
+
         send(action, v)
       end
       self
@@ -84,9 +87,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)
@@ -108,15 +113,18 @@ module Amorail
       )
     end
 
+    # We can have response with 200 or 204 here.
+    # 204 response has no body, so we don't want to parse it.
     def handle_response(response, method)
-      return false unless response.status == 200
-      extract_method = "extract_data_#{method}"
-      reload_model(
-        send(extract_method,
-             response.body['response'][self.class.amo_response_name]
-            )
-      ) if respond_to?(extract_method, true)
-      self
+      return false if response.status == 204
+
+      data = send(
+        "extract_data_#{method}",
+        response.body['response'][self.class.amo_response_name]
+      )
+      reload_model(data)
+    rescue InvalidRecord
+      false
     end
   end
 end

data/lib/amorail/entity/finders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amorail # :nodoc: all
   class Entity
     class << self
@@ -11,38 +13,41 @@ module Amorail # :nodoc: all
       def find!(id)
         rec = find(id)
         fail RecordNotFound unless rec
+
         rec
       end
 
-      def find_all(*ids)
-        ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
-
+      # General method to load many records by proving some filters
+      def where(options)
         response = client.safe_request(
           :get,
           remote_url('list'),
-          id: ids
+          options
         )
         load_many(response)
       end
 
+      def find_all(*ids)
+        ids = ids.first if ids.size == 1 && ids.first.is_a?(Array)
+
+        where(id: ids)
+      end
+
       # Find AMO entities by query
       # Returns array of matching entities.
-      def find_by_query(q)
-        response = client.safe_request(
-          :get,
-          remote_url('list'),
-          query: q
-        )
-        load_many(response)
+      def find_by_query(query)
+        where(query: query)
       end
 
       private
 
+      # We can have response with 200 or 204 here.
+      # 204 response has no body, so we don't want to parse it.
       def load_many(response)
-        return [] unless response.status == 200
+        return [] if response.status == 204
 
-        (response.body['response'][amo_response_name] || [])
-          .map { |info| new.reload_model(info) }
+        response.body['response'].fetch(amo_response_name, [])
+                .map { |info| new.reload_model(info) }
       end
     end