amorail 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f65fb80eb5f426c50e32fa474252e764e42e3887cddbf7f735ad217ad98560cf
+  data.tar.gz: 5f44b5e558be01b346ad68d4d84c903deec88e05514430531b6aa0b6e02c3e73
+SHA512:
+  metadata.gz: 14958c70d64dda63dd82c334d08b2c63cbe8183fbffc8b5c5a63893e42280b0439e8eef4411b9b222c52e54d7dfa0949e82061de6feb4b3814ad169d5ab37cc6
+  data.tar.gz: a370262be82cdde926d639976fea7e23833a6f999cff3100c2a5df57e9962c8ea05b5e6b682e4d2738b4f322a3cba73d81195e721eefe017e8717c103a665f2e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - Rakefile
+    - Gemfile
+    - '*.gemspec'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+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/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+
+before_install: gem install bundler -v 1.13.6
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amorail.gemspec
+gem 'pry-byebug'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 alekseenkoss
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,245 @@
+[![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
+
+AmoCRM client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amorail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amorail
+
+## Usage
+
+With Amorail you can manipulate the following AmoCRM entities: Companies, Contacts, Leads and Tasks.
+We're triying to build simple AR-like interface.
+
+### Auth configuration
+
+Amorail uses [anyway_config](https://github.com/palkan/anyway_config) for configuration, so you
+can provide configuration parameters through env vars, seperate config file (`config/amorail.yml`) or `secrets.yml`.
+
+Required params: **usermail**, **api_key** and **api_endpoint**.
+
+Example:
+
+```
+# config/secrets.yml
+development:
+  ...
+  amorail:
+    usermail: 'amorail@test.com'
+    api_key: '75742b166417fe32ae132282ce178cf6'
+    api_endpoint: 'https://test.amocrm.ru'
+```
+
+### Running from console
+
+You can try amorail in action from console ([PRY](https://github.com/pry/pry) is required to be installed):
+
+```shell
+# amorail gem directory
+AMORAIL_USERMAIL=my_mail@test.com AMORAIL_API_KEY=my_key AMORAIL_API_ENDPOINT=my@amo.com bundle exec rake console
+pry> Amorail.properties
+# ... prints properties (custom_fields) data
+pry> Amorail::Contact.find_by_query("test_contact")
+# ... returns array of contacts which satisfy the query  
+```
+
+### Create new objects
+
+Create Leads
+
+```ruby
+lead = Amorail::Lead.new(
+  name:  "Example Lead",
+  tags: "IT, Sales",
+  price: 100,
+  status_id: Amorail.properties.leads.statuses[
+    Rails.application.secrets.amoparams['lead_status']
+  ].id
+)
+
+lead.save!
+```
+
+Create Company
+
+```ruby
+company = Amorail::Company.new(
+  name: "My company",
+  phone: "222-111",
+  email: "human@example.com"
+)
+company.linked_leads_id << lead.id
+company.save!
+```
+
+Create Contact
+
+```ruby
+contact = Amorail::Contact.new(
+  name: "Ivan Ivanov",
+  linked_company_id: company.id,
+  phone: "111-222",
+  email: "ivan@example.com"
+)
+
+contact.linked_leads_id << lead.id
+contact.save!
+```
+
+Create Task
+
+```ruby
+task = Amorail::Task.new(
+  text: "Example task",
+  lead: true,
+  complete_till: Time.zone.today.end_of_day,
+  task_type: Amorail.properties.tasks[Rails.application.secrets.amoparams['task_code']].id
+)
+
+# set up lead id
+task.element_id = lead.id
+# and save it
+task.save!
+```
+
+You can find any object by id:
+
+```ruby
+  Amorail::Company.find(company_id)
+```
+
+Or using query:
+
+```ruby
+  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
+company = Amorail::Company.find(company_id)
+contact = Amorail::Contact.find(contact_id)
+
+# like this
+contact.linked_company_id = company.id
+contact.save!
+
+# or
+
+contact.update(linked_company_id: company.id)
+```
+
+### Querying
+
+Load by id
+
+```ruby
+Amorail::Contact.find(223) #=> #<Amorail::Contact ...>
+```
+
+Load many entites by array of ids
+
+```ruby
+Amorail::Contact.find_all(123, 124) #=> [#<Amorail::Contact ...>, ...]
+```
+
+Load by query
+
+```ruby
+Amorail::Contact.find_by_query("my_company") #=> [#<Amorail::Contact ...>, ...]
+```
+
+
+Load contacts associated with lead
+
+```ruby
+lead = Amorail::Lead.find(1)
+lead.contacts #=> [#<Amorail::Contact ...>, ...]
+```
+
+Load company associated with contact
+
+```ruby
+contact = Amorail::Contact.find(1)
+contact.company #=> #<Amorail::Company ...>
+```
+
+Load leads associated with contact
+
+```ruby
+contact = Amorail::Contact.find(1)
+contact.leads #=> [#<Amorail::Lead ...>, ...]
+```
+
+Load contacts-leads pairs
+
+```ruby
+# Load all contact-leads pairs for contacts
+Amorail::ContactLink.find_by_contacts(1, 2)
+
+# Load all contact-leads pairs for leads
+Amorail::ContactLink.find_by_leads(1, 2)
+```
+
+### Properties Configuration
+
+AmoCRM is using "custom_fields" architecture,
+to get all information for your account, you can
+find properties and set up configuration manually in config/secrets.yml.
+
+Note: response example in official documentation: 
+      https://developers.amocrm.ru/rest_api/accounts_current.php
+
+1) Get list of properties for your account
+
+```
+rake amorail:check
+```
+Rake task will returns information about properties.
+
+### Multiple configurations
+
+It is possible to use Amorail with multiple AmoCRM accounts. To do so use `Amorail.with_client` method,
+which receive client params or client instance and a block to execute within custom context:
+
+```ruby
+Amorail.with_client(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key") do
+  # Client specific code here
+end
+
+# or using client instance
+my_client = Amorail::Client.new(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key")
+
+Amorail.with_client(client) do
+  ...
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/amorail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Follow style guides (use Rubocop)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require "rubocop/rake_task"
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+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

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amorail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amorail"
+  spec.version       = Amorail::VERSION
+  spec.authors       = ["alekseenkoss", "palkan"]
+  spec.email         = ["alekseenkoss@gmail.com", "dementiev.vm@gmail.com"]
+  spec.summary       = %q{Ruby API client for AmoCRM}
+  spec.description   = %q{Ruby API client for AmoCRM. You can integrate your system with it.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  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 "rubocop", "~> 0.49"
+  spec.add_dependency "anyway_config", "~> 0", ">= 0.3"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'json'
+end

data/lib/amorail.rb

@@ -0,0 +1,49 @@
+require 'amorail/version'
+require 'amorail/config'
+require 'amorail/client'
+require 'amorail/exceptions'
+require 'amorail/entity'
+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
+  end
+
+  def self.properties
+    client.properties
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.client
+    ClientRegistry.client || (@client ||= Client.new)
+  end
+
+  def self.reset
+    @config = nil
+    @client = nil
+  end
+
+  def self.with_client(client)
+    client = Client.new(client) unless client.is_a?(Client)
+    ClientRegistry.client = client
+    yield
+  ensure
+    ClientRegistry.client = nil
+  end
+
+  class ClientRegistry # :nodoc:
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_accessor :client
+  end
+
+  require 'amorail/railtie' if defined?(Rails)
+end