amorail 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db673fd4edfbf45eb53a5d0f975a89d7895fdba
-  data.tar.gz: 356888cd7462e7c1ec8c0b427f422faf6b2da05e
+  metadata.gz: 64a5f20666f547ec054a884b6a11907c10ba6d33
+  data.tar.gz: e7e11f93b5408ffea0f80f15f4e70f4ac03c5ebd
 SHA512:
-  metadata.gz: 97c770c6157118cb4613528c1b0f3ce57f958bb973426b3113bf5c5ee0f7da40d197dc516401568ca0fcc615764484de9936e3ff8f82df2d0c4f59dd406aacd2
-  data.tar.gz: 965e56642519d357ba3eba530bfdd1a8b1f967bb0d8e11ab0dc54ccab032ef82ae40c97a91c0ed396f4cd3a19e72f8a796ea306afae7513616cc0023422fcb64
+  metadata.gz: e3f035e93ac4be0bb929e0ac7f0a0d0bf28bbf43df6d648720554daa5ebffa5a9b7aad22a2ab250629e67c699380743c96dcb207d5bc8300305bec64f8c82c80
+  data.tar.gz: 1f2ece52b8c8755d38d9c05eb74cef43e515daac3cd7223c8fdeb6b9c6fe9f79962972057b7af07fb714f4e86a0f55478ee4e0ce30a48874cb72a2bb7e35a9d8

data/.rubocop.yml

@@ -6,7 +6,9 @@ AllCops:
     - 'spec/**/*.rb'
   Exclude:
     - 'bin/**/*'
-  RunRailsCops: true
+    - Rakefile
+    - Gemfile
+    - '*.gemspec'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
 
@@ -39,5 +41,18 @@ 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

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,8 +22,9 @@ 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_development_dependency "pry"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.0"
+  spec.add_development_dependency "rubocop", "~> 0.49"
   spec.add_dependency "anyway_config", "~> 0", ">= 0.3"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"

data/lib/amorail/entities/elementable.rb

@@ -0,0 +1,37 @@
+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/note.rb

@@ -0,0 +1,17 @@
+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,18 @@
+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
+    amo_names 'tasks'
 
-    validates :element_type, inclusion: 1..2
+    amo_field :task_type, :text, complete_till: :timestamp
 
-    [{ 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
-
-        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/entity.rb

@@ -111,11 +111,13 @@ module Amorail
     def handle_response(response, method)
       return false unless response.status == 200
       extract_method = "extract_data_#{method}"
+      return self unless respond_to?(extract_method, true)
+
       reload_model(
         send(extract_method,
              response.body['response'][self.class.amo_response_name]
             )
-      ) if respond_to?(extract_method, true)
+      )
       self
     end
   end

data/lib/amorail/entity/finders.rb

@@ -14,26 +14,26 @@ module Amorail # :nodoc: all
         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)
+        where(query: q)
       end
 
       private

data/lib/amorail/property.rb

@@ -8,6 +8,10 @@ module Amorail
         super
       end
     end
+
+    def respond_to_missing?(method_sym, *args)
+      args.size.zero? && data.key?(method_sym.to_s)
+    end
   end
 
   class Property # :nodoc: all

data/lib/amorail/railtie.rb

@@ -1,4 +1,5 @@
 module Amorail
+  # Add amorail rake tasks
   class Railtie < Rails::Railtie
     rake_tasks do
       load File.expand_path('../../tasks/amorail.rake', __FILE__)

data/lib/amorail/version.rb

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

data/spec/contact_spec.rb

@@ -136,6 +136,21 @@ describe Amorail::Contact do
     end
   end
 
+  describe ".where" do
+    before { contacts_where_stub(Amorail.config.api_endpoint, query: 'xxx', limit_rows: 10, limit_offset: 100) }
+
+    it "loads entities" do
+      res = described_class.where(query: 'xxx', limit_rows: 10, limit_offset: 100)
+      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
+  end
+
   describe "#save" do
     before { contact_create_stub(Amorail.config.api_endpoint) }
 

data/spec/helpers/webmock_helpers.rb

@@ -150,6 +150,26 @@ module AmoWebMock
     end
   end
 
+  def contacts_where_stub(endpoint, success = true, **params)
+    if success
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/contacts/list"
+      ).with(
+        query: params
+      ).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?query=#{query}")
+        .to_return(status: 204)
+    end
+  end
+
   def company_create_stub(endpoint)
     stub_request(:post, endpoint + '/private/api/v2/json/company/set')
       .to_return(

data/spec/note_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Amorail::Note do
+  before { mock_api }
+
+  it_behaves_like 'elementable'
+
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:text) }
+    it { is_expected.to validate_presence_of(:note_type) }
+    it { is_expected.to validate_inclusion_of(:element_type).in_range(1..4) }
+  end
+
+  describe '.attributes' do
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify do
+      is_expected.to include(
+        :text,
+        :note_type
+      )
+    end
+  end
+end

data/spec/support/elementable_example.rb

@@ -0,0 +1,52 @@
+shared_examples 'elementable' do
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:element_id) }
+    it { is_expected.to validate_presence_of(:element_type) }
+  end
+
+  describe '.attributes' do
+    subject { described_class.attributes }
+
+    specify do
+      is_expected.to include(
+        :element_type,
+        :element_id
+      )
+    end
+  end
+
+  describe '#params' do
+    subject { elementable.params }
+
+    let(:elementable) do
+      described_class.new(
+        element_id: 1,
+        element_type: 2
+      )
+    end
+
+    it { is_expected.to include(element_id: 1) }
+    it { is_expected.to include(element_type: 2) }
+  end
+
+  describe 'element type behaviour' do
+    let(:elementable) { described_class.new }
+
+    it 'set element_type on initialize' do
+      expect(described_class.new(lead: true).element_type).to eq 2
+      expect(described_class.new(lead: false).element_type).to be_nil
+      expect(described_class.new(contact: true).contact?).to be_truthy
+    end
+
+    it 'set element_type with bang method' do
+      elementable.contact!
+      expect(elementable.element_type).to eq 1
+
+      elementable.lead!
+      expect(elementable.element_type).to eq 2
+
+      elementable.company!
+      expect(elementable.element_type).to eq 3
+    end
+  end
+end

data/spec/task_spec.rb

@@ -3,13 +3,13 @@ require "spec_helper"
 describe Amorail::Task do
   before { mock_api }
 
+  it_behaves_like 'elementable'
+
   describe "validations" do
-    it { should validate_presence_of(:element_id) }
-    it { should validate_presence_of(:element_type) }
-    it { should validate_inclusion_of(:element_type).in_range(1..2) }
-    it { should validate_presence_of(:text) }
-    it { should validate_presence_of(:task_type) }
-    it { should validate_presence_of(:complete_till) }
+    it { is_expected.to validate_presence_of(:text) }
+    it { is_expected.to validate_presence_of(:task_type) }
+    it { is_expected.to validate_presence_of(:complete_till) }
+    it { is_expected.to validate_inclusion_of(:element_type).in_range(1..3) }
   end
 
   describe ".attributes" do
@@ -19,8 +19,6 @@ describe Amorail::Task do
 
     specify do
       is_expected.to include(
-        :element_type,
-        :element_id,
         :text,
         :task_type,
         :complete_till
@@ -28,27 +26,9 @@ describe Amorail::Task do
     end
   end
 
-  describe "contact and lead" do
-    let(:task) { described_class.new }
-    it "set element_type on initialize" do
-      expect(described_class.new(lead: true).element_type).to eq 2
-      expect(described_class.new(contact: true).contact?).to be_truthy
-      expect(described_class.new(lead: false).element_type).to be_nil
-    end
-
-    it "set element_type with bang method" do
-      task.contact!
-      expect(task.element_type).to eq 1
-      task.lead!
-      expect(task.element_type).to eq 2
-    end
-  end
-
   describe "#params" do
     let(:task) do
       described_class.new(
-        element_id: 1,
-        element_type: 1,
         text: 'Win the war',
         task_type: 'test',
         complete_till: '2015-05-09 12:00:00'
@@ -58,8 +38,6 @@ describe Amorail::Task do
     subject { task.params }
 
     specify { is_expected.to include(:last_modified) }
-    specify { is_expected.to include(element_id: 1) }
-    specify { is_expected.to include(element_type: 1) }
     specify { is_expected.to include(text: 'Win the war') }
     specify { is_expected.to include(task_type: 'test') }
     specify {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amorail
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - alekseenkoss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: anyway_config
   requirement: !ruby/object:Gem::Requirement
@@ -180,7 +194,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -194,8 +207,10 @@ files:
 - lib/amorail/entities/company.rb
 - lib/amorail/entities/contact.rb
 - lib/amorail/entities/contact_link.rb
+- lib/amorail/entities/elementable.rb
 - lib/amorail/entities/lead.rb
 - lib/amorail/entities/leadable.rb
+- lib/amorail/entities/note.rb
 - lib/amorail/entities/task.rb
 - lib/amorail/entity.rb
 - lib/amorail/entity/finders.rb
@@ -225,8 +240,10 @@ files:
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb
 - spec/my_contact_spec.rb
+- spec/note_spec.rb
 - spec/property_spec.rb
 - spec/spec_helper.rb
+- spec/support/elementable_example.rb
 - spec/support/entity_class_example.rb
 - spec/support/leadable_example.rb
 - spec/support/my_contact.rb
@@ -276,8 +293,10 @@ test_files:
 - spec/helpers/webmock_helpers.rb
 - spec/lead_spec.rb
 - spec/my_contact_spec.rb
+- spec/note_spec.rb
 - spec/property_spec.rb
 - spec/spec_helper.rb
+- spec/support/elementable_example.rb
 - spec/support/entity_class_example.rb
 - spec/support/leadable_example.rb
 - spec/support/my_contact.rb

data/.hound.yml

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