amorail 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c91d42f4e1991fe27ebde64b7e88f8537c90ad7
-  data.tar.gz: 18665c9622339679e5d419d7dec829e1c736ad6c
+  metadata.gz: d0fe2be0f031e806dd9eac0da0ac09ee4a9b5d79
+  data.tar.gz: ae1153aee232f6d0b30190a68e0e2b2e9d15cdd7
 SHA512:
-  metadata.gz: 2b4b928c8a32c0a3ed07fa0e8aed9c916cfd401ebed5c97bcc989d9e71dd37d9ee5b6b9f559a0a504949c0a78198c05dacb7b3efcd7217279e603838f442c713
-  data.tar.gz: 514dc9cbbfc728f82d240208b71d202f0fb129e3ee3457c19ecb08c6c6a0b951df45749652e75e44dde6903113af66e80ad175bbce274840babcf22e0091a1f5
+  metadata.gz: 32b9fb3a98d3ac82dd40e9c7fd4f9aeb079d8f942a72f98428de7bf13712a1edea8d2b7562e16974d8ddadd4e80024e5119ca79d3e6cb6a7118535367922e312
+  data.tar.gz: 224079bf6eb4bb040a72386fd589b0f4aca5bb76df7a1c69ba9e6cd923e9064db53ab3c8d7be3f941f891df2bfb0932b0e56499ba64b9c7637977eafedf2558c

data/.gitignore

@@ -7,7 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/lib/amorail/entities/
 *.bundle
 *.so
 *.o

data/.hound.yml

@@ -1,2 +1,12 @@
 ruby:
   enabled: true
+  config_file: .rubocop.yml
+
+javascript:
+  enabled: false
+
+coffeescript:
+  enabled: false
+
+sass:
+  enabled: false

data/.rubocop.yml

@@ -16,3 +16,17 @@ Style/Documentation:
 
 Style/StringLiterals: 
   Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/lib/amorail/client.rb

@@ -4,14 +4,15 @@ require 'json'
 require 'active_support'
 
 module Amorail
+  # Amorail http client
   class Client
     attr_accessor :cookies
 
     def initialize
       @host = Amorail.config.api_endpoint
-      @connect = Faraday.new(url: @host) do |faraday|           
-        faraday.adapter  Faraday.default_adapter
-        faraday.response :json, :content_type => /\bjson$/
+      @connect = Faraday.new(url: @host) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.response :json, content_type: /\bjson$/
         faraday.use :instrumentation
       end
     end
@@ -19,30 +20,34 @@ module Amorail
     def connect
       @connect || self.class.new
     end
-    
+
     def authorize
-      response = post(Amorail.config.auth_url, {'USER_LOGIN' => Amorail.config.usermail, 'USER_HASH' => Amorail.config.api_key})
+      response = post(
+        Amorail.config.auth_url,
+        'USER_LOGIN' => Amorail.config.usermail,
+        'USER_HASH' => Amorail.config.api_key
+      )
       cookie_handler(response)
       response
     end
-    
-    def safe_request(method, url, params={}) 
-      self.send(method, url, params)
-    rescue ::Amorail::AmoUnauthorizedError => e
+
+    def safe_request(method, url, params = {})
+      send(method, url, params)
+    rescue ::Amorail::AmoUnauthorizedError
       authorize
-      self.send(method, url, params)
+      send(method, url, params)
     end
 
-    def get(url, params={})
+    def get(url, params = {})
       response = connect.get(url, params) do |request|
-        request.headers['Cookie'] = self.cookies if self.cookies.present?
+        request.headers['Cookie'] = cookies if cookies.present?
       end
       handle_response(response)
     end
 
-    def post(url, params={})
+    def post(url, params = {})
       response = connect.post(url) do |request|
-        request.headers['Cookie'] = self.cookies if self.cookies.present?
+        request.headers['Cookie'] = cookies if cookies.present?
         request.headers['Content-Type'] = 'application/json'
         request.body = params.to_json
       end
@@ -53,29 +58,29 @@ module Amorail
       self.cookies = response.headers['set-cookie'].split('; ')[0]
     end
 
-    def handle_response(response)
-      return response if response.status == 200 or response.status == 204
-        
+    def handle_response(response) # rubocop:disable all
+      return response if response.status == 200 || response.status == 204
+
       case response.status
       when 301
-        raise ::Amorail::AmoMovedPermanentlyError
+        fail ::Amorail::AmoMovedPermanentlyError
       when 400
-        raise ::Amorail::AmoBadRequestError
-      when 401 
-        raise ::Amorail::AmoUnauthorizedError
+        fail ::Amorail::AmoBadRequestError
+      when 401
+        fail ::Amorail::AmoUnauthorizedError
       when 403
-        raise ::Amorail::AmoForbiddenError
+        fail ::Amorail::AmoForbiddenError
       when 404
-        raise ::Amorail::AmoNotFoudError
+        fail ::Amorail::AmoNotFoudError
       when 500
-        raise ::Amorail::AmoInternalError
+        fail ::Amorail::AmoInternalError
       when 502
-        raise ::Amorail::AmoBadGatewayError
+        fail ::Amorail::AmoBadGatewayError
       when 503
-        raise ::Amorail::AmoServiceUnaviableError
+        fail ::Amorail::AmoServiceUnaviableError
       else
-        raise ::Amorail::AmoUnknownError(response.body)
+        fail ::Amorail::AmoUnknownError(response.body)
       end
     end
   end
-end
+end

data/lib/amorail/config.rb

@@ -1,6 +1,12 @@
 require 'anyway'
 
 module Amorail
+  # Amorail config contains:
+  # - usermail ("user@gmail.com")
+  # - api_key ("13601bbac84727df")
+  # - api_endpoint ("http://you_company.amocrm.com")
+  # - api_path (default: "/private/api/v2/json/")
+  # - auth_url (default: "/private/api/auth.php?type=json")
   class Config < Anyway::Config
     attr_config :usermail,
                 :api_key,
@@ -8,4 +14,4 @@ module Amorail
                 api_path: "/private/api/v2/json/",
                 auth_url: "/private/api/auth.php?type=json"
   end
-end
+end

data/lib/amorail/engine.rb

@@ -2,10 +2,11 @@ require 'amorail'
 require 'rails'
 
 module Amorail
+  # Amorail Rails engine
+  # Load Amorails rake tasks
   class Engine < Rails::Engine
     rake_tasks do
       load File.expand_path("../../tasks/amorail.rake", __FILE__)
     end
   end
 end
-

data/lib/amorail/entities/company.rb

@@ -1,4 +1,7 @@
+require 'amorail/entities/leadable'
+
 module Amorail
+  # AmoCRM company entity
   class AmoCompany < Amorail::AmoEntity
     include Leadable
     amo_names 'company', 'contacts'

data/lib/amorail/entities/contact.rb

@@ -1,12 +1,15 @@
+require 'amorail/entities/leadable'
+
 module Amorail
+  # AmoCRM contact entity
   class AmoContact < Amorail::AmoEntity
     include Leadable
     amo_names 'contacts'
 
     amo_field :name, :company_name
 
-    amo_property :email, enum: 'MOB'
-    amo_property :phone, enum: 'WORK'
+    amo_property :email, enum: 'WORK'
+    amo_property :phone, enum: 'MOB'
     amo_property :position
 
     validates :name, presence: true

data/lib/amorail/entities/lead.rb

@@ -1,4 +1,5 @@
 module Amorail
+  # AmoCRM lead entity
   class AmoLead < Amorail::AmoEntity
     amo_names "leads"
 

data/lib/amorail/entities/leadable.rb

@@ -0,0 +1,6 @@
+module Amorail
+  # Lead associations
+  module Leadable
+    # TODO: !!!
+  end
+end

data/lib/amorail/entities/task.rb

@@ -1,4 +1,5 @@
 module Amorail
+  # AmoCRM task entity
   class AmoTask < Amorail::AmoEntity
     amo_names "tasks"
 
@@ -12,21 +13,6 @@ module Amorail
 
     validates :element_type, inclusion: 1..2
 
-    def params
-      {
-        id: id,
-        text: text,
-        date_create: to_timestamp(date_create),
-        last_modified: to_timestamp(last_modified) || Time.now.to_i,
-        request_id: request_id,
-        responsible_user_id: responsible_user_id,
-        element_id: element_id,
-        element_type: element_type,
-        task_type: task_type,
-        complete_till: to_timestamp(complete_till)
-      }
-    end
-
     [{ name: "contact", val: 1 }, { name: "lead", val: 2 }].each do |prop|
       class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{prop[:name]}=(val)

data/lib/amorail/entity/finders.rb

@@ -0,0 +1,30 @@
+module Amorail # :nodoc: all
+  class AmoEntity
+    class << self
+      def find(id)
+        new.load_record(id)
+      end
+
+      def find!(id)
+        rec = find(id)
+        fail RecordNotFound unless rec
+        rec
+      end
+    end
+
+    def load_record(id)
+      response = client.safe_request(
+        :get,
+        remote_url('list'),
+        id: id
+      )
+      handle_response(response, 'load')
+    end
+
+    private
+
+    def extract_data_load(response)
+      response.first
+    end
+  end
+end

data/lib/amorail/entity/params.rb

@@ -0,0 +1,95 @@
+module Amorail # :nodoc: all
+  class AmoEntity
+    def params
+      data = {}
+      self.class.attributes.each do |k, v|
+        data[k] = send("to_#{v}", send(k))
+      end
+
+      data[:custom_fields] = custom_fields if properties.respond_to?(amo_name)
+
+      normalize_params(data)
+    end
+
+    protected
+
+    def custom_fields
+      props = properties.send(self.class.amo_name)
+
+      custom_fields = []
+
+      self.class.properties.each do |k, v|
+        prop_id = props.send(k).id
+        prop_val = { value: send(k) }.merge(v)
+        custom_fields << { id: prop_id, values: [prop_val] }
+      end
+
+      custom_fields
+    end
+
+    def create_params(method)
+      {
+        request: {
+          self.class.amo_response_name => {
+            method => [
+              params
+            ]
+          }
+        }
+      }
+    end
+
+    def normalize_custom_fields(val)
+      val.reject do |field|
+        field[:values].all? { |item| !item[:value] }
+      end
+    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)
+      return data unless data.is_a?(Hash)
+
+      compacted = {}
+      data.each do |key, val|
+        case val
+        when Numeric, String
+          compacted[key] = val
+        when Array
+          val.compact!
+          # handle custom keys
+          val = normalize_custom_fields(val) if key == :custom_fields
+          unless val.empty?
+            compacted[key] = val.map { |el| normalize_params(el) }
+          end
+        else
+          params = normalize_params(val)
+          compacted[key] = params unless params.nil?
+        end
+      end
+      compacted.with_indifferent_access
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
+
+    def to_timestamp(val)
+      return if val.nil?
+
+      case val
+      when String
+        (date = Time.parse(val)) && date.to_i
+      when Date
+        val.to_time.to_i
+      else
+        val.to_i
+      end
+    end
+
+    def to_default(val)
+      val
+    end
+  end
+end

data/lib/amorail/entity/persistance.rb

@@ -0,0 +1,47 @@
+module Amorail # :nodoc: all
+  class AmoEntity
+    class InvalidRecord < ::Amorail::Error; end
+    class NotPersisted < ::Amorail::Error; end
+
+    def new_record?
+      id.blank?
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    def save
+      return false unless valid?
+      new_record? ? push('add') : push('update')
+    end
+
+    def save!
+      if save
+        true
+      else
+        fail InvalidRecord
+      end
+    end
+
+    def update(attrs = {})
+      return false if new_record?
+      merge_params(attrs)
+      push('update')
+    end
+
+    def update!(attrs = {})
+      if update(attrs)
+        true
+      else
+        fail NotPersisted
+      end
+    end
+
+    private
+
+    def extract_data_add(response)
+      response.fetch('add').first
+    end
+  end
+end

data/lib/amorail/entity.rb

@@ -1,17 +1,16 @@
 require 'active_model'
 
 module Amorail
+  # Core class for all Amo entities (company, contact, etc)
   class AmoEntity
     include ActiveModel::Model
     include ActiveModel::AttributeMethods
     include ActiveModel::Validations
 
-    class InvalidRecord < ::Amorail::Error; end
-    class NotPersisted < ::Amorail::Error; end
     class RecordNotFound < ::Amorail::Error; end
 
     class << self
-      attr_reader :amo_name, :amo_response_name, :attributes, :properties
+      attr_reader :amo_name, :amo_response_name
 
       def amo_names(name, response_name = nil)
         @amo_name = @amo_response_name = name
@@ -19,26 +18,23 @@ module Amorail
       end
 
       def amo_field(*vars, **hargs)
-        @attributes ||= {}
-        vars.each { |v| @attributes[v] = :default }
-        hargs.each { |k, v| @attributes[k] = v }
-        attr_accessor(*@attributes.keys)
+        vars.each { |v| attributes[v] = :default }
+        hargs.each { |k, v| attributes[k] = v }
+        attr_accessor(*(vars + hargs.keys))
       end
 
       def amo_property(name, options = {})
-        @properties ||= {}
-        @properties[name] = options
+        properties[name] = options
         attr_accessor(name)
       end
 
-      def find(id)
-        new.load_record(id)
+      def attributes
+        @attributes ||=
+          superclass.respond_to?(:attributes) ? superclass.attributes.dup : {}
       end
 
-      def find!(id)
-        rec = find(id)
-        fail RecordNotFound unless rec
-        rec
+      def properties
+        @properties ||= {}
       end
     end
 
@@ -48,145 +44,16 @@ module Amorail
               date_create: :timestamp, last_modified: :timestamp
 
     delegate :client, :properties, to: Amorail
+    delegate :amo_name, to: :class
 
     def initialize(attributes = {})
       super(attributes)
       self.last_modified = Time.now.to_i if last_modified.nil?
     end
 
-    def new_record?
-      id.blank?
-    end
-
-    def persisted?
-      !new_record?
-    end
-
-    def load_record(id)
-      response = client.safe_request(
-        :get,
-        remote_url('list'),
-        id: id
-      )
-      handle_response(response, 'load')
-    end
-
-    def save
-      return false unless valid?
-      new_record? ? push('add') : push('update')
-    end
-
-    def save!
-      if save
-        true
-      else
-        fail InvalidRecord
-      end
-    end
-
-    def update(attrs = {})
-      return false if new_record?
-      merge_params(attrs)
-      push('update')
-    end
-
-    def update!(attrs = {})
-      if update(attrs)
-        true
-      else
-        fail NotPersisted
-      end
-    end
-
-    def params
-      data = {}
-      self.class.attributes.each do |k, v|
-        data[k] = send("to_#{v}", send(k))
-      end
-
-      data[:custom_fields] = custom_fields
-
-      normalize_params(data)
-    end
-
-    protected
-
-    def custom_fields
-      return unless properties.respond_to?(self.class.amo_name)
-
-      return if self.class.properties.nil?
-
-      props = properties.send(self.class.amo_name)
-
-      custom_fields = []
-
-      self.class.properties.each do |k, v|
-        prop_id = props.send(k).id
-        prop_val = { value: send(k) }.merge(v)
-        custom_fields << { id: prop_id, values: [prop_val] }
-      end
-
-      custom_fields
-    end
-
-    def create_params(method)
-      {
-        request: {
-          self.class.amo_response_name => {
-            method => [
-              params
-            ]
-          }
-        }
-      }
-    end
-
-    def normalize_custom_fields(val)
-      val.reject do |field|
-        field[:values].all? { |item| !item[:value] }
-      end
-    end
-
-    # this method removes nil values and empty arrays from params hash (deep)
-    def normalize_params(data)
-      return data unless data.is_a?(Hash)
-
-      compacted = {}
-      data.each do |key, val|
-        case val
-        when Numeric, String
-          compacted[key] = val
-        when Array
-          val.compact!
-          # handle custom keys
-          val = normalize_custom_fields(val) if key == :custom_fields
-          unless val.empty?
-            compacted[key] = val.map { |el| normalize_params(el) }
-          end
-        else
-          params = normalize_params(val)
-          compacted[key] = params unless params.nil?
-        end
-      end
-      compacted.with_indifferent_access
-    end
-
-    def to_timestamp(val)
-      return if val.nil?
-
-      case val
-      when String
-        (date = Time.parse(val)) && date.to_i
-      when Date
-        val.to_time.to_i
-      else
-        val.to_i
-      end
-    end
-
-    def to_default(val)
-      val
-    end
+    require 'amorail/entity/params'
+    require 'amorail/entity/persistance'
+    require 'amorail/entity/finders'
 
     def reload_model(info)
       merge_params(info)
@@ -214,10 +81,6 @@ module Amorail
       end
     end
 
-    def attributes_list
-      self.class.attributes
-    end
-
     def remote_url(action)
       File.join(Amorail.config.api_path, self.class.amo_name, action)
     end
@@ -238,26 +101,14 @@ module Amorail
     end
 
     def handle_response(response, method)
-      if 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
-      else
-        false
-      end
-    end
-
-    def extract_data_load(response)
-      response.first
-    end
-
-    def extract_data_add(response)
-      response.fetch('add').first
+      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
     end
   end
 end