amorail 0.1.4 → 0.1.5

data/lib/amorail/exceptions.rb

@@ -1,11 +1,10 @@
-# Classes for Amorail Exceptions
+# Amorail Exceptions.
 # Every class is name of HTTP response error code(status)
-
 module Amorail
   class Error < ::StandardError; end
 
   class APIError < Error; end
-  
+
   class AmoBadRequestError < APIError; end
 
   class AmoMovedPermanentlyError < APIError; end
@@ -23,4 +22,4 @@ module Amorail
   class AmoServiceUnaviableError < APIError; end
 
   class AmoUnknownError < APIError; end
-end
+end

data/lib/amorail/{custom_fields.rb → property.rb}

@@ -1,8 +1,8 @@
 module Amorail
-
+  # Return hash key as method call
   module MethodMissing
     def method_missing(method_sym, *arguments, &block)
-      if data.has_key?(method_sym.to_s)
+      if data.key?(method_sym.to_s)
         data.fetch(method_sym.to_s)
       else
         super
@@ -10,10 +10,22 @@ module Amorail
     end
   end
 
-  class Property
+  class Property # :nodoc: all
     class PropertyItem
       include MethodMissing
 
+      class << self
+        attr_accessor :source_name
+
+        def parse(data)
+          hash = {}
+          data['custom_fields'][source_name].each do |contact|
+            hash[contact['code'].downcase] = PropertyItem.new(contact)
+          end
+          new hash
+        end
+      end
+
       attr_reader :data
 
       def initialize(data)
@@ -32,7 +44,7 @@ module Amorail
         @statuses = data
       end
     end
-    
+
     attr_reader :client, :data, :contacts,
                 :company, :leads, :tasks
 
@@ -45,9 +57,12 @@ module Amorail
       @data = load_fields
       parse_all_data
     end
-    
+
     def load_fields
-      response = client.safe_request(:get, '/private/api/v2/json/accounts/current')
+      response = client.safe_request(
+        :get,
+        '/private/api/v2/json/accounts/current'
+      )
       response.body["response"]["account"]
     end
 
@@ -65,23 +80,11 @@ module Amorail
     end
 
     class Contact < PropertyItem
-      def self.parse(data)
-        hash = {}
-        data['custom_fields']['contacts'].each do |contact|
-          hash[contact['code'].downcase] = PropertyItem.new(contact)
-        end
-        new hash
-      end
+      self.source_name = 'contacts'
     end
 
     class Company < PropertyItem
-      def self.parse(data)
-        hash = {}
-        data['custom_fields']['companies'].each do |company|
-          hash[company['code'].downcase] = PropertyItem.new(company)
-        end
-        new hash
-      end
+      self.source_name = 'companies'
     end
 
     class Lead < StatusItem
@@ -106,4 +109,4 @@ module Amorail
       end
     end
   end
-end
+end

data/lib/amorail/version.rb

@@ -1,3 +1,4 @@
+# Amorail version
 module Amorail
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/amorail.rb

@@ -3,12 +3,12 @@ require 'amorail/config'
 require 'amorail/client'
 require 'amorail/exceptions'
 require 'amorail/entity'
-require 'amorail/custom_fields'
-
-require 'amorail/entities/leadable'
+require 'amorail/property'
 
 Gem.find_files('amorail/entities/*.rb').each { |path| require path }
 
+# AmoCRM API integration.
+# https://www.amocrm.com/
 module Amorail
   def self.config
     @config ||= Config.new

data/lib/tasks/amorail.rake

@@ -1,8 +1,8 @@
 require 'amorail'
 
 namespace :amorail do
-  desc "Check Amorails configuration. Authorize and get custom fields information"
+  desc "Check Amorail configuration."
   task :check do
-    p Amorail.properties
+    p Amorail.properties.inspect
   end
-end
+end

data/spec/client_spec.rb

@@ -20,4 +20,4 @@ describe Amorail::Client do
     res = client.get("/private/api/v2/json/accounts/current")
     expect(res.status).to eq 200
   end
-end
+end

data/spec/company_spec.rb

@@ -2,14 +2,28 @@ require "spec_helper"
 
 describe Amorail::AmoCompany do
   before { mock_api }
-  
+
   describe "validations" do
     it { should validate_presence_of(:name) }
   end
 
+  describe ".attributes" do
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify { is_expected.to include(:name) }
+  end
+
+  describe ".properties" do
+    subject { described_class.properties }
+
+    specify { is_expected.to include(:email, :phone, :web, :address) }
+  end
+
   describe "#params" do
     let(:company) do
-      Amorail::AmoCompany.new(
+      described_class.new(
         name: 'Test inc',
         phone: '12345678',
         email: 'test@mala.ru',
@@ -20,6 +34,7 @@ describe Amorail::AmoCompany do
 
     subject { company.params }
 
+    specify { is_expected.to include(:last_modified) }
     specify { is_expected.to include(name: 'Test inc') }
     specify { is_expected.to include(type: 'contact') }
 
@@ -27,14 +42,16 @@ describe Amorail::AmoCompany do
       prop = subject[:custom_fields].detect { |p| p[:id] == "1460591" }
       expect(prop).not_to be_nil
       expect(prop[:values].first[:value]).to eq 'test@mala.ru'
-      expect(prop[:values].first[:enum]).to eq 'WORK'
+      expect(prop[:values].first[:enum])
+        .to eq described_class.properties[:email][:enum]
     end
 
     it "contains phone property" do
       prop = subject[:custom_fields].detect { |p| p[:id] == "1460589" }
       expect(prop).not_to be_nil
       expect(prop[:values].first[:value]).to eq '12345678'
-      expect(prop[:values].first[:enum]).to eq 'WORK'
+      expect(prop[:values].first[:enum])
+        .to eq described_class.properties[:phone][:enum]
     end
 
     it "contains address property" do
@@ -51,7 +68,7 @@ describe Amorail::AmoCompany do
   end
 
   describe "#save" do
-    let(:company) { Amorail::AmoCompany.new(name: "test") }
+    let(:company) { described_class.new(name: "test") }
 
     before { company_create_stub(Amorail.config.api_endpoint) }
 

data/spec/contact_spec.rb

@@ -3,15 +3,29 @@ require "spec_helper"
 describe Amorail::AmoContact do
   before { mock_api }
 
-  let(:contact) { Amorail::AmoContact.new(name: "test") }
+  let(:contact) { described_class.new(name: "test") }
 
   describe "validations" do
-    it { should validate_presence_of(:name)}
+    it { should validate_presence_of(:name) }
+  end
+
+  describe ".attributes" do
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify { is_expected.to include(:name, :company_name) }
+  end
+
+  describe ".properties" do
+    subject { described_class.properties }
+
+    specify { is_expected.to include(:email, :phone, :position) }
   end
 
   describe "#params" do
     let(:contact) do
-      Amorail::AmoContact.new(
+      described_class.new(
         name: 'Tester',
         company_name: 'Test inc',
         phone: '12345678',
@@ -22,6 +36,7 @@ describe Amorail::AmoContact do
 
     subject { contact.params }
 
+    specify { is_expected.to include(:last_modified) }
     specify { is_expected.to include(name: 'Tester') }
     specify { is_expected.to include(company_name: 'Test inc') }
 
@@ -29,14 +44,16 @@ describe Amorail::AmoContact do
       prop = subject[:custom_fields].detect { |p| p[:id] == "1460591" }
       expect(prop).not_to be_nil
       expect(prop[:values].first[:value]).to eq 'test@mala.ru'
-      expect(prop[:values].first[:enum]).to eq 'MOB'
+      expect(prop[:values].first[:enum])
+        .to eq described_class.properties[:email][:enum]
     end
 
     it "contains phone property" do
       prop = subject[:custom_fields].detect { |p| p[:id] == "1460589" }
       expect(prop).not_to be_nil
       expect(prop[:values].first[:value]).to eq '12345678'
-      expect(prop[:values].first[:enum]).to eq 'WORK'
+      expect(prop[:values].first[:enum])
+        .to eq described_class.properties[:phone][:enum]
     end
 
     it "contains position property" do
@@ -51,20 +68,21 @@ describe Amorail::AmoContact do
     before { contact_find_stub(Amorail.config.api_endpoint, 102, false) }
 
     it "loads entity" do
-      obj = Amorail::AmoContact.find(101)
+      obj = described_class.find(101)
       expect(obj.id).to eq 101
       expect(obj.company_name).to eq "Foo Inc."
       expect(obj.email).to eq "foo@tb.com"
       expect(obj.phone).to eq "1111 111 111"
+      expect(obj.params[:id]).to eq 101
     end
 
     it "returns nil" do
-      obj = Amorail::AmoContact.find(102)
+      obj = described_class.find(102)
       expect(obj).to be_falsey
     end
 
     it "raise error" do
-      expect { Amorail::AmoContact.find!(102) }
+      expect { described_class.find!(102) }
         .to raise_error(Amorail::AmoEntity::RecordNotFound)
     end
   end
@@ -91,12 +109,12 @@ describe Amorail::AmoContact do
     end
 
     it "raise error if id is blank?" do
-      obj = Amorail::AmoContact.new
+      obj = described_class.new
       expect { obj.update!(name: 'Igor') }.to raise_error
     end
 
     it "raise error" do
-      obj = Amorail::AmoContact.new
+      obj = described_class.new
       expect { obj.update!(id: 101, name: "Igor") }
         .to(raise_error)
     end

data/spec/entity_spec.rb

@@ -3,7 +3,9 @@ require "spec_helper"
 describe Amorail::AmoEntity do
   before { mock_api }
 
-  let(:entity) { Amorail::AmoEntity.new }
+  let(:entity) { described_class.new }
+
+  it_behaves_like 'entity_class'
 
   describe "#params" do
     let(:now) { Time.now }
@@ -11,13 +13,14 @@ describe Amorail::AmoEntity do
     subject { entity.params }
 
     specify { is_expected.to include(:last_modified) }
-    specify { is_expected.not_to include(
-      :id, :request_id, :responsible_user_id, :date_create)
+    specify {
+      is_expected.not_to include(
+        :id, :request_id, :responsible_user_id, :date_create)
     }
 
     context "with some values" do
       let(:entity) do
-        Amorail::AmoEntity.new(
+        described_class.new(
           responsible_user_id: 2,
           last_modified: now
         )
@@ -25,14 +28,15 @@ describe Amorail::AmoEntity do
 
       specify { is_expected.to include(responsible_user_id: 2) }
       specify { is_expected.to include(last_modified: now.to_i) }
-      specify { is_expected.not_to include(
-        :id, :request_id, :date_create)
+      specify {
+        is_expected.not_to include(
+          :id, :request_id, :date_create)
       }
     end
 
     context "with all values" do
       let(:entity) do
-        Amorail::AmoEntity.new(
+        described_class.new(
           id: 100,
           request_id: 1,
           responsible_user_id: 2,

data/spec/helpers/webmock_helpers.rb

@@ -1,64 +1,96 @@
-def mock_api
-  authorize_stub(Amorail.config.api_endpoint, 
-    Amorail.config.usermail, 
-    Amorail.config.api_key)
+module AmoWebMock
+  def mock_api
+    authorize_stub(
+      Amorail.config.api_endpoint,
+      Amorail.config.usermail,
+      Amorail.config.api_key)
 
-  account_info_stub(Amorail.config.api_endpoint)
-end
+    account_info_stub(Amorail.config.api_endpoint)
+  end
 
-def authorize_stub(endpoint, usermail, api_key)
-  stub_request(:post, "#{endpoint}/private/api/auth.php?type=json").
-         with(:body => "{\"USER_LOGIN\":\"#{usermail}\",\"USER_HASH\":\"#{api_key}\"}",
-              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.1'}).
-         to_return(:status => 200, :body => "", :headers => {'Set-Cookie' => 'PHPSESSID=58vorte6dd4t7h6mtuig9l0p50; path=/; domain=amocrm.ru'})
-end
+  def authorize_stub(endpoint, usermail, api_key)
+    cookie = 'PHPSESSID=58vorte6dd4t7h6mtuig9l0p50; path=/; domain=amocrm.ru'
+    stub_request(:post, "#{endpoint}/private/api/auth.php?type=json")
+      .with(
+        body: "{\"USER_LOGIN\":\"#{usermail}\",\"USER_HASH\":\"#{api_key}\"}"
+      )
+      .to_return(
+        status: 200,
+        body: "",
+        headers: {
+          'Set-Cookie' => cookie
+        })
+  end
 
-def account_info_stub(endpoint)
-  stub_request(:get, endpoint + '/private/api/v2/json/accounts/current').to_return(
-            :body => File.read('./spec/fixtures/account_response.json'), headers: {'Content-Type'=>'application/json'}, status: 200
-          )
-end
+  def account_info_stub(endpoint)
+    stub_request(:get, endpoint + '/private/api/v2/json/accounts/current')
+      .to_return(
+        body: File.read('./spec/fixtures/account_response.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
 
-def unauthorized_account_info_stub(endpoint)
-  stub_request(:get, endpoint + '/private/api/v2/json/accounts/current').to_return(
-    :body => "", status: 401
-  )
-end
+  def unauthorized_account_info_stub(endpoint)
+    stub_request(:get, endpoint + '/private/api/v2/json/accounts/current')
+      .to_return(
+        body: "", status: 401
+      )
+  end
 
-def bad_req_account_info_stub(endpoint)
-  stub_request(:post, endpoint + '/private/api/v2/json/accounts/current').with(:body => "{}",
-          :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.1'}).to_return(
-    :body => "", status: 400
-  )
-end
+  def bad_req_account_info_stub(endpoint)
+    stub_request(:post, endpoint + '/private/api/v2/json/accounts/current')
+      .with(body: "{}")
+      .to_return(
+        body: "",
+        status: 400
+      )
+  end
 
-def contact_create_stub(endpoint)
-  stub_request(:post, endpoint + '/private/api/v2/json/contacts/set').with(
-          :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.1'}).to_return(
-    :body => File.read('./spec/fixtures/contact_create.json'), headers: {'Content-Type'=>'application/json'}, status: 200
-  )
-end
+  def contact_create_stub(endpoint)
+    stub_request(:post, endpoint + '/private/api/v2/json/contacts/set')
+      .to_return(
+        body: File.read('./spec/fixtures/contact_create.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
 
-def contact_update_stub(endpoint)
-  stub_request(:post, endpoint + '/private/api/v2/json/contacts/set').with(
-          :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.1'}).to_return(
-    :body => File.read('./spec/fixtures/contact_update.json'), headers: {'Content-Type'=>'application/json'}, status: 200
-  )
-end
+  def contact_update_stub(endpoint)
+    stub_request(:post, endpoint + '/private/api/v2/json/contacts/set')
+      .to_return(
+        body: File.read('./spec/fixtures/contact_update.json'),
+        headers: {
+          'Content-Type' => 'application/json'
+        },
+        status: 200
+      )
+  end
 
-def contact_find_stub(endpoint, id, success = true)
-  if success
-    stub_request(:get, "#{endpoint}/private/api/v2/json/contacts/list?id=#{id}").to_return(
-      :body => File.read('./spec/fixtures/contact_find.json'), headers: {'Content-Type'=>'application/json'}, status: 200
-    )
-  else
-    stub_request(:get, "#{endpoint}/private/api/v2/json/contacts/list?id=#{id}").to_return(body: nil, status: 204)
+  def contact_find_stub(endpoint, id, success = true)
+    if success
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/contacts/list?id=#{id}")
+        .to_return(
+          body: File.read('./spec/fixtures/contact_find.json'),
+          headers: { 'Content-Type' => 'application/json' },
+          status: 200
+        )
+    else
+      stub_request(
+        :get,
+        "#{endpoint}/private/api/v2/json/contacts/list?id=#{id}")
+        .to_return(body: nil, status: 204)
+    end
   end
-end
 
-def company_create_stub(endpoint)
-  stub_request(:post, endpoint + '/private/api/v2/json/company/set').with(
-          :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.9.1'}).to_return(
-    :body => File.read('./spec/fixtures/contact_create.json'), headers: {'Content-Type'=>'application/json'}, status: 200
-  )
+  def company_create_stub(endpoint)
+    stub_request(:post, endpoint + '/private/api/v2/json/company/set')
+      .to_return(
+        body: File.read('./spec/fixtures/contact_create.json'),
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+  end
 end

data/spec/lead_spec.rb

@@ -4,13 +4,28 @@ describe Amorail::AmoLead do
   before { mock_api }
 
   describe "validations" do
-    it { should validate_presence_of(:name)}
-    it { should validate_presence_of(:status_id)}
+    it { should validate_presence_of(:name) }
+    it { should validate_presence_of(:status_id) }
+  end
+
+  describe ".attributes" do
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify do
+      is_expected.to include(
+        :name,
+        :price,
+        :status_id,
+        :tags
+      )
+    end
   end
 
   describe "#params" do
     let(:lead) do
-      Amorail::AmoLead.new(
+      described_class.new(
         name: 'Test',
         price: 100,
         status_id: 2,
@@ -20,6 +35,7 @@ describe Amorail::AmoLead do
 
     subject { lead.params }
 
+    specify { is_expected.to include(:last_modified) }
     specify { is_expected.to include(name: 'Test') }
     specify { is_expected.to include(price: 100) }
     specify { is_expected.to include(status_id: 2) }

data/spec/{custom_class_spec.rb → property_spec.rb}

@@ -1,14 +1,14 @@
 require "spec_helper"
 require "webmock/rspec"
 
-describe "spec for Amorail Properties" do
+describe Amorail::Property do
   before(:each) { mock_api }
 
-  let(:prop) {Amorail.properties}
+  let(:prop) { Amorail.properties }
 
   it "should parse companies hash" do
     expect(prop.company.phone.present?).to be_truthy
-    expect(prop.company.phone.is_a?(Amorail::Property::PropertyItem)).to be_truthy
+    expect(prop.company.phone.is_a?(described_class::PropertyItem)).to be_truthy
     expect(prop.company.phone.id.present?).to be_truthy
     expect(prop.company.data["phone"].data["id"]).to eq prop.company.phone.id
 
@@ -20,7 +20,7 @@ describe "spec for Amorail Properties" do
 
   it "should parse contacts hash" do
     expect(prop.contacts.email.present?).to be_truthy
-    expect(prop.contacts.im.is_a?(Amorail::Property::PropertyItem)).to be_truthy
+    expect(prop.contacts.im.is_a?(described_class::PropertyItem)).to be_truthy
     expect(prop.contacts.im.id.present?).to be_truthy
     expect(prop.contacts.data["im"].data["id"]).to eq prop.contacts.im.id
 
@@ -39,4 +39,4 @@ describe "spec for Amorail Properties" do
     expect(prop.tasks.follow_up.id).to eq 1
     expect(prop.tasks["CALL"].id).to eq 1
   end
-end
+end

data/spec/spec_helper.rb

@@ -8,10 +8,12 @@ require 'webmock/rspec'
 require 'shoulda/matchers'
 require 'helpers/webmock_helpers'
 
+ENV.clear
 ENV["AMORAIL_CONF"] = File.expand_path("../fixtures/amorail_test.yml", __FILE__)
 
-Dir[File.expand_path("../support/**/*.rb",__FILE__)].each {|f| require f}
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
   config.mock_with :rspec
-end
+  include AmoWebMock
+end

data/spec/support/entity_class_example.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+shared_examples 'entity_class' do
+  subject { described_class.attributes }
+
+  specify do
+    is_expected.to include(
+      :id,
+      :request_id,
+      :responsible_user_id,
+      :date_create,
+      :last_modified
+    )
+  end
+end