retailcrm-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecac159b5dfa1826977b6d2e158b7068fb41239d37cda2e9e7965a44f81bc886
+  data.tar.gz: 1fde1dcc5a9c929c42147f1da8e3f4308473485e85f77a8e98efddb4fa9ff63d
+SHA512:
+  metadata.gz: eedb55035f7278c8b11e7babc274270e3ee1bb4e4a2750b2a15bf6e40c678a604128e81dad3ec27a2a26609a4da23887ed0f4bf60cbd55acc6be6b2212d5f7f0
+  data.tar.gz: 87c6371d1e6ec724f866278f8d23487fcb46ae75b619aed65c6df6abb50ee7746e1c331ca3db1f14605c68741bf55fd03cb6c28750a788d92eff76f33cd7cfb4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Pavel Osetrov
+
+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.markdown

@@ -0,0 +1,72 @@
+# RetailCRM API
+
+API wrapper для RetailCRM
+
+# Установка Ruby
+
+## Ruby
+    $ gem install retailcrm-api
+## Rails
+добавьте в Gemfile:
+    gem 'retailcrm-api'
+
+и запустите `bundle install`.
+
+Затем:
+    rails g retailcrm_api:install
+## Требования
+
+Необходимо получить api key https://yourdomains.retailcrm.ru/admin/api-keys
+
+## Использование Rails
+
+В файл `config/retailcrm_api.yml` вставьте ваши данные
+
+## Использование Ruby
+
+Сначала создайте экземпляр объекта `RetailcrmApi::Request`:
+
+```ruby
+retailcrm = RetailcrmApi::Request.new(api_key: "your_api_key")
+```
+
+Вы можете изменять `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+
+```ruby
+RetailcrmApi::Request.api_key = "your_api_key"
+RetailcrmApi::Request.timeout = 15
+RetailcrmApi::Request.open_timeout = 15
+RetailcrmApi::Request.symbolize_keys = true
+RetailcrmApi::Request.debug = false
+```
+
+Либо в файле `config/initializers/retailcrm_api.rb` для Rails.
+
+## Debug Logging
+
+Измените `debug: true` чтобы включить логирование в STDOUT.
+
+```ruby
+retailcrm = RetailcrmApi::Request.new(api_key: "your_api_key", debug: true)
+```
+
+### Custom logger
+
+`Logger.new` используется по умолчанию, но вы можете изменить на свой:
+
+```ruby
+retailcrm = RetailcrmApi::Request.new(api_key: "your_api_key", debug: true, logger: MyLogger.new)
+```
+
+Или:
+
+```ruby
+RetailcrmApi::Request.logger = MyLogger.new
+```
+
+# Примеры
+
+```ruby
+RetailcrmApi::Request.customers.retrieve.body
+#=> {:success=>true, :pagination=>{:limit=>20, :totalCount=>0, :currentPage=>1, :totalPageCount=>0}, :customers=>[]} 
+```

data/lib/generators/retailcrm_api/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+  retailcrm_api:install

data/lib/generators/retailcrm_api/install/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+#
+module RetailcrmApi
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def generate_install
+      copy_file 'retailcrm_api.yml', 'config/retailcrm_api.yml'
+      copy_file 'retailcrm_api.rb', 'config/initializers/retailcrm_api.rb'
+    end
+  end
+end
+

data/lib/generators/retailcrm_api/install/templates/retailcrm_api.rb

@@ -0,0 +1,17 @@
+require 'retailcrm-api'
+
+RetailcrmApi.setup do |config|
+  if File.exist?('config/retailcrm_api.yml')
+    processed = YAML.load_file('config/retailcrm_api.yml')[Rails.env]
+
+    processed.each do |k, v|
+      config::register k.underscore.to_sym, v
+    end
+
+    config::Request.api_key ||= ENV['RETAILCRM_API_KEY']
+    config::Request.timeout = 60
+    config::Request.open_timeout = 60
+    config::Request.symbolize_keys = true
+    config::Request.debug = false
+  end
+end

data/lib/generators/retailcrm_api/install/templates/retailcrm_api.yml

@@ -0,0 +1,9 @@
+defaults: &defaults
+  API_KEY: '***'
+  API_ENDPOINT: 'https://yourdomain.retailcrm.ru'
+production:
+  <<: *defaults
+development:
+  <<: *defaults
+test:
+  <<: *defaults

data/lib/retailcrm-api.rb

@@ -0,0 +1,54 @@
+require 'retailcrm-api/version'
+require 'retailcrm-api/retailcrm_error'
+require 'retailcrm-api/retailcrm_api_error'
+require 'retailcrm-api/request'
+require 'retailcrm-api/api_request'
+require 'retailcrm-api/response'
+
+module RetailcrmApi
+  class << self
+    def setup
+      yield self
+    end
+
+    def register(name, value, type = nil)
+      cattr_accessor "#{name}_setting".to_sym
+
+      add_reader(name)
+      add_writer(name, type)
+      send "#{name}=", value
+    end
+
+    def add_reader(name)
+      define_singleton_method(name) do |*args|
+        send("#{name}_setting").value(*args)
+      end
+    end
+
+    def add_writer(name, type)
+      define_singleton_method("#{name}=") do |value|
+        send("#{name}_setting=", DynamicSetting.build(value, type))
+      end
+    end
+  end
+
+  class DynamicSetting
+    def self.build(setting, type)
+      (type ? klass(type) : self).new(setting)
+    end
+
+    def self.klass(type)
+      klass = "#{type.to_s.camelcase}Setting"
+      raise ArgumentError, "Unknown type: #{type}" unless RetailcrmApi.const_defined?(klass)
+      RetailcrmApi.const_get(klass)
+    end
+
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def value(*_args)
+      @setting
+    end
+  end
+end

data/lib/retailcrm-api/api_request.rb

@@ -0,0 +1,154 @@
+module RetailcrmApi
+  class APIRequest
+
+    def initialize(builder: nil)
+      @request_builder = builder
+    end
+
+    def post(params: nil, headers: nil, suffix: nil, body: {}, first_time: true)
+      validate_api_key
+
+      begin
+        response = self.rest_client(suffix).post do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def get(params: nil, headers: nil, first_time: true)
+      validate_api_key
+
+      begin
+        response = self.rest_client.get do |request|
+          configure_request(request: request, params: params, headers: headers)
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    protected
+
+    # Convenience accessors
+
+    def api_key
+      @request_builder.api_key
+    end
+
+    def api_endpoint
+      @request_builder.api_endpoint
+    end
+
+    def timeout
+      @request_builder.timeout
+    end
+
+    def open_timeout
+      @request_builder.open_timeout
+    end
+
+    def proxy
+      @request_builder.proxy
+    end
+
+    def adapter
+      @request_builder.faraday_adapter
+    end
+
+    def symbolize_keys
+      @request_builder.symbolize_keys
+    end
+
+    # Helpers
+
+    def handle_error(error)
+      error_params = {}
+
+      begin
+        if error.is_a?(Faraday::ClientError) && error.response
+          error_params[:status_code] = error.response[:status]
+          error_params[:raw_body] = error.response[:body]
+
+          parsed_response = MultiJson.load(error.response[:body], symbolize_keys: symbolize_keys)
+
+          if parsed_response
+            error_params[:body] = parsed_response
+
+            title_key = symbolize_keys ? :title : "title"
+            detail_key = symbolize_keys ? :detail : "detail"
+
+            error_params[:title] = parsed_response[title_key] if parsed_response[title_key]
+            error_params[:detail] = parsed_response[detail_key] if parsed_response[detail_key]
+          end
+
+        end
+      rescue MultiJson::ParseError
+      end
+
+      error_to_raise = RetailcrmError.new(error.message, error_params)
+
+      raise error_to_raise
+    end
+
+    def configure_request(request: nil, params: nil, headers: nil, body: nil)
+      if request
+        request.params.merge!(params) if params
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-API-KEY'] = "#{self.api_key}"
+        request.headers['User-Agent'] = "RetailCrmApi/#{RetailcrmApi::VERSION} Ruby gem"
+        request.headers.merge!(headers) if headers
+        request.body = body if body
+        request.options.timeout = self.timeout
+        request.options.open_timeout = self.open_timeout
+      end
+    end
+
+    def rest_client(suffix=nil)
+      client = Faraday.new("#{self.api_url}#{suffix.present? ? "/#{suffix}": ""}", proxy: self.proxy,
+                           ssl: { version: "TLSv1_2" }) do |faraday|
+        faraday.response :raise_error
+        faraday.adapter adapter
+        if @request_builder.debug
+          faraday.response :logger, @request_builder.logger, bodies: true
+        end
+      end
+      client
+    end
+
+    def parse_response(response)
+      parsed_response = nil
+
+      if response.body && !response.body.empty?
+        begin
+          headers = response.headers
+          body = MultiJson.load(response.body, symbolize_keys: symbolize_keys)
+          parsed_response = Response.new(headers: headers, body: body)
+        rescue MultiJson::ParseError
+          error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
+          error = RetailcrmError.new("Unparseable response: #{response.body}", error_params)
+          raise error
+        end
+      end
+
+      parsed_response
+    end
+
+    def validate_api_key
+      unless self.api_key && self.api_endpoint
+        raise RetailcrmApi::RetailcrmApiError, "You must set an api_key prior to making a call #{self.api_key} #{self.api_endpoint}"
+      end
+    end
+
+    def api_url
+      base_api_url + @request_builder.path
+    end
+
+    def base_api_url
+      "#{RetailcrmApi.api_endpoint}/api/v5/"
+    end
+  end
+end

data/lib/retailcrm-api/request.rb

@@ -0,0 +1,92 @@
+module RetailcrmApi
+  class Request
+    attr_accessor :api_key, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger, :test
+
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false)
+      p "Request initialize #{api_key}"
+
+      @path_parts = []
+      @api_key = api_key || self.class.api_key || ENV['RETAILCRM_API_KEY']
+      @api_key = @api_key.strip if @api_key
+      @api_key = RetailcrmApi::api_key if @api_key.nil?
+      @api_endpoint = api_endpoint || self.class.api_endpoint
+      @api_endpoint = RetailcrmApi::api_endpoint if @api_endpoint.nil?
+      @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
+      @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
+      @proxy = proxy || self.class.proxy || ENV['RETAILCRM_API_PROXY']
+      @faraday_adapter = faraday_adapter || self.class.faraday_adapter || Faraday.default_adapter
+      @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
+      @debug = debug || self.class.debug || false
+      @test = test || self.class.test || false
+      @logger = logger || self.class.logger || ::Logger.new(STDOUT)
+    end
+
+    def method_missing(method, *args)
+      @path_parts << method.to_s.downcase
+      @path_parts << args if args.length > 0
+      @path_parts.flatten!
+      self
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
+    def send(*args)
+      if args.length == 0
+        method_missing(:send, args)
+      else
+        __send__(*args)
+      end
+    end
+
+    def path
+      @path_parts.join('/')
+    end
+
+    def create(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'update', body: body, suffix: 'create')
+    ensure
+      reset
+    end
+
+    def update(params: nil, headers: nil, body: {})
+      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'update', body: body)
+    ensure
+      reset
+    end
+
+    def retrieve(params: nil, headers: nil)
+      APIRequest.new(builder: self).get(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    def delete(params: nil, headers: nil, suffix: 'delete')
+      APIRequest.new(builder: self).post(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    protected
+
+    def reset
+      @path_parts = []
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger, :test
+
+      def method_missing(sym, *args, &block)
+        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger, test: self.test).send(sym, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+    end
+  end
+end

data/lib/retailcrm-api/response.rb

@@ -0,0 +1,10 @@
+module RetailcrmApi
+  class Response
+    attr_accessor :body, :headers
+    
+    def initialize(body: {}, headers: {})
+      @body = body
+      @headers = headers
+    end 
+  end
+end

data/lib/retailcrm-api/retailcrm_api_error.rb

@@ -0,0 +1,29 @@
+module RetailcrmApi
+  class RetailcrmApiError < StandardError
+    attr_reader :title, :detail, :body, :raw_body, :status_code
+
+    def initialize(message = "", params = {})
+      @title       = params[:title]
+      @detail      = params[:detail]
+      @body        = params[:body]
+      @raw_body    = params[:raw_body]
+      @status_code = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:title, :detail, :body, :raw_body, :status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end

data/lib/retailcrm-api/retailcrm_error.rb

@@ -0,0 +1,29 @@
+module RetailcrmApi
+  class RetailcrmError < StandardError
+    attr_reader :title, :detail, :body, :raw_body, :status_code
+
+    def initialize(message = "", params = {})
+      @title       = params[:title]
+      @detail      = params[:detail]
+      @body        = params[:body]
+      @raw_body    = params[:raw_body]
+      @status_code = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:title, :detail, :body, :raw_body, :status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end

data/lib/retailcrm-api/version.rb

@@ -0,0 +1,3 @@
+module RetailcrmApi
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: retailcrm-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Osetrov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+description: ''
+email: pavel.osetrov@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- lib/generators/retailcrm_api/install/USAGE
+- lib/generators/retailcrm_api/install/install_generator.rb
+- lib/generators/retailcrm_api/install/templates/retailcrm_api.rb
+- lib/generators/retailcrm_api/install/templates/retailcrm_api.yml
+- lib/retailcrm-api.rb
+- lib/retailcrm-api/api_request.rb
+- lib/retailcrm-api/request.rb
+- lib/retailcrm-api/response.rb
+- lib/retailcrm-api/retailcrm_api_error.rb
+- lib/retailcrm-api/retailcrm_error.rb
+- lib/retailcrm-api/version.rb
+homepage: https://github.com/osetrov/retailcrm-api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: RetailCRM API
+test_files: []