amo_crm 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bcdfe457e805bcd13291af40d904d6a66164b3c
+  data.tar.gz: 9dc97f28498ace5952964d4841222a974526a39c
+SHA512:
+  metadata.gz: ea06783bfd4d9fabaea1fce866275a2f8a8fa62f7d99e16a091aecd356ebf654e9455f4af2da6ca55e1e356f2b972afde20b4ded21f03cd512b191927ea57e3c
+  data.tar.gz: 31f5f2485883e27b060d8fda3b9c7666fb3a7e46d57b3b93355d597793ae3b895e6f4303890f122b980d03411a7f76961d00663ce8e3f26546efc98b474b3f7b

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+test.*
+tags
+gems.tags
+.bundle
+.config
+.yardoc
+*.swp
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+*.bak
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## 0.2.1 - beta
+
+* Классификация возмжных ошибок от API
+
+## 0.2.0 / 2014-12-20
+
+* Добавил сущность PriceType и ресурс price_types
+* Переименовал Metadata в EmbeddedEntityMetadata
+
+## 0.1.5 / 2014-12-05
+
+* Больше документации.
+* Зависимости перенесены из Gemfile в gemspec. Спасибо @wyde19
+
+## 0.1.4 / 2014-12-04
+
+* Universe.build для ленивого создания вселенной
+
+## 0.1.3 / 2014-12-04
+
+* Примеры использования и больше документации
+* Сущности Country и Uom

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amo_crm.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard 'ctags-bundler', :src_path => ["lib", "spec/support"] do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Danil Pismenny
+
+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 @@
+#  Ruby-клиент для REST XML API AmoCRM

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+
+rescue LoadError
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  #t.options = ['--any', '--extra', '--opts'] # optional
+end

data/amo_crm.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amo_crm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amo_crm"
+  spec.version       = AmoCRM::VERSION
+  spec.authors       = ["Danil Pismenny"]
+  spec.email         = ["danil@brandymint.ru"]
+  spec.summary       = %q{Клиент для работы с API amocrm.ru}
+  spec.description   = %q{Правильный клиент для работы c REST XML API moyslad.ru, созданный по принципам SOLID}
+  spec.homepage      = "https://github.com/brandymint/amo_crm"
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'virtus'
+  spec.add_runtime_dependency 'hashie'
+  spec.add_runtime_dependency 'faraday-cookie_jar'
+  spec.add_runtime_dependency 'nokogiri-happymapper'
+  spec.add_runtime_dependency 'activesupport', '>=3.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency 'guard-ctags-bundler'
+  spec.add_development_dependency 'yard'
+end

data/dump_amocrm_account.rb

@@ -0,0 +1,7 @@
+require 'json'
+
+a = AmoCRM::Client.new url: ENV['AMOCRM_URL'] || 'https://kiosk.amocrm.ru'
+a.authorize user_login: ENV['AMOCRM_LOGIN'], user_hash: ENV['AMOCRM_APIKEY']
+account = a.get('accounts/current')['account']
+
+File.write 'account.json', JSON.pretty_generate(account.as_json)

data/lib/amo_crm.rb

@@ -0,0 +1,31 @@
+require 'happymapper'
+require 'active_support'
+require 'active_model'
+ActiveModel::Serializers::JSON
+require "amo_crm/version"
+
+require 'logger'
+
+module AmoCRM
+  mattr_accessor :custom_logger
+  extend ActiveSupport::Autoload
+
+  autoload :Entities
+  autoload :Resources
+  autoload :Client
+  autoload :Universe
+
+  def self.logger= value
+    self.custom_logger = value
+  end
+
+  def self.logger
+    return custom_logger if custom_logger
+
+    if defined? Rails
+      Rails.logger
+    else
+      Logger.new STDERR
+    end
+  end
+end

data/lib/amo_crm/client.rb

@@ -0,0 +1,98 @@
+require 'faraday'
+require 'json'
+require 'hashie'
+
+require_relative 'client/errors'
+
+class AmoCRM::Client
+  PREFIX_PATH = '/private/api/v2/json/'
+
+  SESSION_TIMEOUT = 15*60 # 15 minutes - https://developers.amocrm.ru/rest_api/auth.php
+
+  def initialize url:
+    @connection = Faraday.new url
+    # 'private/api/v2/json/'
+    # connection.use :cookie_jar
+    # connection.response :logger
+    connection.request :url_encoded
+  end
+
+  def authorize(user_login: , user_hash: )
+    logger.debug "Client: Authorize #{user_login}"
+    path = "private/api/auth.php?type=json"
+    data = { USER_LOGIN: user_login, USER_HASH: user_hash }
+    @user_login = user_login
+    @user_hash = user_hash
+    response = connection.post path, data
+    # Success reponse header example:
+    # "set-cookie"=> "session_id=nic2a7t2mauuooc8a45pbm3p85nlf1nm9tr4cltpfl3r5kfk4um0; path=/; domain=.amocrm.ru, BITRIX_SM_LOGIN=danil%40brandymint.ru; expires=Thu, 26-Aug-2021 13:34:47 GMT; Max-
+    # "expires"=>"Thu, 19 Nov 1981 08:52:00 GMT",
+    #
+    # Success response body example:
+    # "{\"response\":{\"auth\":true,\"accounts\":[{\"id\":\"11413681\",\"name\":\"Kiosk\",\"subdomain\":\"kiosk\",\"language\":\"ru\",\"timezone\":\"Europe\\/Moscow\"}],\"server_time\":1474464887}}"
+    @authorized_at = Time.zone.now
+    @cookie = response.headers['set-cookie']
+    logger.debug "Client: Authorization response #{response.body}"
+    validate response
+  end
+
+  def authorize!(user_login: , user_hash: )
+    res = authorize user_login: user_login, user_hash: user_hash
+    raise "AmoCRM is not authorized #{res}" unless res.auth
+
+    res
+  end
+
+  def get path, params={}
+    logger.debug "Client: GET #{path} #{params}"
+    check_authorization!
+    validate connection.get PREFIX_PATH + path, params, { Cookie: cookie }
+  end
+
+  def post path, data=nil
+    data = JSON.generate data.as_json
+    logger.debug "Client: POST #{path}: #{data}"
+    check_authorization!
+    validate connection.post PREFIX_PATH + path, data, { 'Content-Type' => 'application/json', Cookie: cookie }
+  end
+
+  def put path, data
+    data = JSON.generate data.as_json
+    logger.debug "Client: PUT #{path}: #{data}"
+    check_authorization!
+    validate connection.put PREFIX_PATH + path, data, { 'Content-Type' => 'application/json', Cookie: cookie }
+  end
+
+  def delete path
+    check_authorization!
+    validate connection.delete PREFIX_PATH path
+  end
+
+  private
+
+  attr_reader :connection, :cookie
+
+  def check_authorization!
+    return true unless session_expired?
+    raise 'No user_login to reauthorize' unless @user_login
+    res = authorize user_login: @user_login, user_hash: @user_hash
+    raise "AmoCRM is not reauthorized #{res}" unless res.auth
+
+    res
+  end
+
+  def session_expired?
+    return !cookie || !@authorized_at || @authorized_at + SESSION_TIMEOUT <= Time.zone.now
+  end
+
+  def logger
+    AmoCRM.logger
+  end
+
+  def validate res
+    AmoCRM::Client::Errors.build res unless res.status == 200
+
+    data = JSON.parse(res.body)['response']
+    Hashie::Mash.new data
+  end
+end

data/lib/amo_crm/client/error.rb

@@ -0,0 +1,18 @@
+class AmoCRM::Client
+  class Error < StandardError
+    attr_reader :state, :body
+
+    def initialize state, body
+      @state = state
+      @body = body
+    end
+
+    def message
+      to_s
+    end
+
+    def to_s
+      "#{state}: #{body}"
+    end
+  end
+end

data/lib/amo_crm/client/errors.rb

@@ -0,0 +1,16 @@
+require_relative 'error'
+
+class AmoCRM::Client
+  class Errors
+    def self.build res
+      if res.try(:body).present?
+        AmoCRM.logger.error "AmoCRM::Client: #{res.class} #{res.headers['Content-Type']} #{res.status}: #{res.env.url.to_s}\n#{res.body}"
+        body = JSON.parse(res.body) rescue { 'response' => body }
+        raise Error.new res.status, body['response']
+      else
+        AmoCRM.logger.error "AmoCRM::Client: #{res.class} #{res}"
+        raise Error.new 999, res.to_json
+      end
+    end
+  end
+end

data/lib/amo_crm/entities.rb

@@ -0,0 +1,14 @@
+module AmoCRM
+  module Entities
+    extend ActiveSupport::Autoload
+
+    %w{
+    Base
+    Account
+    CustomField
+    Company
+    }.each do |m|
+      autoload m
+    end
+  end
+end

data/lib/amo_crm/entities/account.rb

@@ -0,0 +1,7 @@
+module AmoCRM::Entities
+  class Account < Base
+    def self.parse(response)
+      new response
+    end
+  end
+end

data/lib/amo_crm/entities/attachment_document.rb

@@ -0,0 +1,16 @@
+module AmoCRM::Entities
+  class AttachmentDocument < Base
+    include AmoCRM::Entities::Common
+
+    tag 'file'
+
+    attribute :filename,       String
+    attribute :miniatureUuid,  String
+    attribute :name,           String
+
+    #def self.parse node, options
+      ## TODO create AttachmentDocument
+      #''
+    #end
+  end
+end

data/lib/amo_crm/entities/attribute.rb

@@ -0,0 +1,71 @@
+module AmoCRM::Entities
+  class Attribute < Base
+    include AmoCRM::Entities::Common
+
+    tag 'attribute'
+
+    # 
+    attribute :metadataUuid,    String
+    attribute :valueString,     String
+    attribute :valueText,       String
+    attribute :doubleValue,     Float
+    attribute :longValue,       Integer
+    attribute :booleanValue,    Boolean
+    attribute :timeValue,       String
+
+    attribute :agentValueUuid, String
+    attribute :goodValueUuid, String
+    attribute :placeValueUuid, String
+    attribute :consignmentValueUuid, String
+    attribute :employeeValueUuid, String
+    attribute :projectValueUuid, String
+    attribute :contractValueUuid, String
+
+    attribute :file, AmoCRM::Entities::AttachmentDocument
+
+    attribute :entityValueUuid, String
+
+    # Объект описывающий тип атритуба
+    #
+    # @return AmoCRM::Entities::AttributeMetadata
+    #
+    def metadata universe
+      universe.embedded_entity_metadata.subresource_by_name(:GoodFolder).find metadataUuid
+    end
+
+    # Название свойства, полученное из AttributeMetadata
+    #
+    # @return String
+    #
+    def attributeName universe
+      metadata(universe).name
+    end
+
+    # Значение свойства согласно его типу
+    #
+    # @return [String | AmoCRM::Entities::CustomEntity | Integer | Decimal ]
+    def get_value universe
+      md = metadata universe
+      case md.attrType
+      when 'ID_CUSTOM'
+        universe.custom_entities.find( entityValueUuid ).name
+      when 'LINK'
+        valueText
+      when 'TEXT'
+        valueText
+      when 'STRING'
+        valueString
+      when 'DOUBLE'
+        doubleValue
+      when 'LONG'
+        longValue
+      when 'TIME'
+        timeValue
+      when 'FILE'
+        file
+      else
+        raise "Не известный тип мета-аттрибута #{md.uuid}: #{md.attrType}"
+      end
+    end
+  end
+end