amorail 0.5.0

data/spec/my_contact_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe MyContact do
+  before { mock_api }
+
+  describe ".properties" do
+    subject { described_class.properties }
+
+    specify do
+      is_expected.to include(:email, :phone, :teachbase_id)
+    end
+  end
+
+  describe "#params" do
+    let(:company) do
+      described_class.new(
+        name: 'Test inc',
+        phone: '12345678',
+        email: 'test@mala.ru',
+        teachbase_id: 123
+      )
+    end
+
+    subject { company.params }
+
+    specify { is_expected.to include(:last_modified) }
+    specify { is_expected.to include(name: 'Test inc') }
+
+    it "contains custom property" do
+      prop = subject[:custom_fields].detect { |p| p[:id] == "116302" }
+      expect(prop).not_to be_nil
+      expect(prop[:values].first[:value]).to eq 123
+    end
+  end
+
+  describe ".find" do
+    before { my_contact_find_stub(Amorail.config.api_endpoint, 11) }
+
+    it "loads entity" do
+      obj = described_class.find(11)
+      expect(obj.id).to eq 11
+      expect(obj.company_name).to eq "Foo Inc."
+      expect(obj.email).to eq "foo@tb.com"
+      expect(obj.teachbase_id).to eq 1123
+      expect(obj.params[:id]).to eq 11
+    end
+  end
+end

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/property_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "webmock/rspec"
+
+describe Amorail::Property do
+  before(:each) { mock_api }
+
+  let(:prop) { Amorail.properties }
+
+  it "should parse companies hash" do
+    expect(prop.company.phone.present?).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
+
+    expect(prop.company.phone.id).to eq "1460589"
+    expect(prop.company.address.id).to eq "1460597"
+    expect(prop.company.email.id).to eq "1460591"
+    expect(prop.company.web.id).to eq "1460593"
+  end
+
+  it "should parse contacts hash" do
+    expect(prop.contacts.email.present?).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
+
+    expect(prop.contacts.im.id).to eq "1460595"
+    expect(prop.contacts.position.id).to eq "1460587"
+    expect(prop.contacts.phone.id).to eq "1460589"
+    expect(prop.contacts.email.id).to eq "1460591"
+    expect(prop.contacts.teachbase_id.id).to eq "116302"
+  end
+
+  it "should parse leads hash" do
+    expect(prop.leads.textfield.id).to eq "484604"
+    expect(prop.leads.flag.id).to eq "484606"
+    expect(prop.leads.statuses["Первичный контакт"].id).to eq "8195972"
+    expect(prop.leads.statuses["Успешно реализовано"].id).to eq "142"
+  end
+
+  it "should parse task types" do
+    expect(prop.tasks.follow_up.id).to eq 1
+    expect(prop.tasks["CALL"].id).to eq 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'amorail'
+require 'pry-byebug'
+require 'webmock/rspec'
+require 'shoulda/matchers'
+require 'helpers/webmock_helpers'
+
+# Cleanup Amorail env
+ENV.delete_if { |k, _| k =~ /amorail/i }
+ENV["AMORAIL_CONF"] = File.expand_path("fixtures/amorail_test.yml", __dir__)
+
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  include AmoWebMock
+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/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

data/spec/support/leadable_example.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+shared_examples 'leadable' do
+  let(:leadable) { described_class.new }
+  subject { leadable.params }
+
+  specify { is_expected.not_to include(:linked_leads_id) }
+
+  context 'with leads' do
+    before { leadable.linked_leads_id << 100 }
+    specify { is_expected.to include(:linked_leads_id) }
+    specify { expect(subject.fetch(:linked_leads_id)).to include(100) }
+  end
+
+  describe "#leads" do
+    before { leads_stub(Amorail.config.api_endpoint, [1, 2]) }
+
+    let(:leadable) { described_class.new(linked_leads_id: ['1', '2']) }
+
+    it "loads leads" do
+      expect(leadable.leads.size).to eq 2
+      expect(leadable.leads.first).to be_a(Amorail::Lead)
+      expect(leadable.leads.first.name).to eq "Research new technologies"
+    end
+
+    it "cache results" do
+      url = URI.join(Amorail.config.api_endpoint, Amorail::Lead.remote_url('list'))
+      leadable.leads
+      leadable.leads
+      expect(WebMock).to have_requested(:get, url).with(query: { id: [1, 2] }).once
+    end
+  end
+end

data/spec/support/my_contact.rb

@@ -0,0 +1,3 @@
+class MyContact < Amorail::Contact # :nodoc:
+  amo_property :teachbase_id
+end

data/spec/support/my_entity.rb

@@ -0,0 +1,4 @@
+# We only need this class to set Amo names for core Entity
+class MyEntity < Amorail::Entity # :nodoc:
+  amo_names 'entity'
+end

data/spec/task_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Amorail::Task 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(: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
+    subject { described_class.attributes }
+
+    it_behaves_like 'entity_class'
+
+    specify do
+      is_expected.to include(
+        :text,
+        :task_type,
+        :complete_till
+      )
+    end
+  end
+
+  describe "#params" do
+    let(:task) do
+      described_class.new(
+        text: 'Win the war',
+        task_type: 'test',
+        complete_till: '2015-05-09 12:00:00'
+      )
+    end
+
+    subject { task.params }
+
+    specify { is_expected.to include(:last_modified) }
+    specify { is_expected.to include(text: 'Win the war') }
+    specify { is_expected.to include(task_type: 'test') }
+    specify {
+      is_expected.to include(
+        complete_till: Time.local(2015, 5, 9, 12, 0, 0).to_i
+      )
+    }
+  end
+end

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

@@ -0,0 +1,319 @@
+--- !ruby/object:Gem::Specification
+name: amorail
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- alekseenkoss
+- palkan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API client for AmoCRM. You can integrate your system with it.
+email:
+- alekseenkoss@gmail.com
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amorail.gemspec
+- lib/amorail.rb
+- lib/amorail/client.rb
+- lib/amorail/config.rb
+- 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/entities/webhook.rb
+- lib/amorail/entity.rb
+- lib/amorail/entity/finders.rb
+- lib/amorail/entity/params.rb
+- lib/amorail/entity/persistence.rb
+- lib/amorail/exceptions.rb
+- lib/amorail/property.rb
+- lib/amorail/railtie.rb
+- lib/amorail/version.rb
+- lib/tasks/amorail.rake
+- spec/client_spec.rb
+- spec/company_spec.rb
+- spec/contact_link_spec.rb
+- spec/contact_spec.rb
+- spec/entity_spec.rb
+- spec/fixtures/accounts/response_1.json
+- spec/fixtures/accounts/response_2.json
+- spec/fixtures/amorail_test.yml
+- spec/fixtures/contacts/create.json
+- spec/fixtures/contacts/find_many.json
+- spec/fixtures/contacts/find_one.json
+- spec/fixtures/contacts/links.json
+- spec/fixtures/contacts/my_contact_find.json
+- spec/fixtures/contacts/update.json
+- spec/fixtures/leads/create.json
+- spec/fixtures/leads/find_many.json
+- 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
+- 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
+- spec/support/my_entity.rb
+- spec/task_spec.rb
+- spec/webhook_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby API client for AmoCRM
+test_files:
+- spec/client_spec.rb
+- spec/company_spec.rb
+- spec/contact_link_spec.rb
+- spec/contact_spec.rb
+- spec/entity_spec.rb
+- spec/fixtures/accounts/response_1.json
+- spec/fixtures/accounts/response_2.json
+- spec/fixtures/amorail_test.yml
+- spec/fixtures/contacts/create.json
+- spec/fixtures/contacts/find_many.json
+- spec/fixtures/contacts/find_one.json
+- spec/fixtures/contacts/links.json
+- spec/fixtures/contacts/my_contact_find.json
+- spec/fixtures/contacts/update.json
+- spec/fixtures/leads/create.json
+- spec/fixtures/leads/find_many.json
+- 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
+- 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
+- spec/support/my_entity.rb
+- spec/task_spec.rb
+- spec/webhook_spec.rb