ekam-ruby 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGFiMTczNDA4ZGYyYjlmZDg0OTViMWE0MWQ5MjdlMTAyMzQ3YWMyNg==
+  data.tar.gz: !binary |-
+    ZDAxMDEzMmRiOWQ0NGRjM2M0YzYyN2MzMTNmNmNjMmQ4OGE5ZDVhMw==
+SHA512:
+  metadata.gz: !binary |-
+    NTUzNTAxYTMzOTNlMTUwYjlmNzc1MzQxZjY4Yjg5NWY2ZmE4ZjA2MjFiMzBl
+    ZGRjN2VkNmFmMzA2ZmQ4MmZkZDdlN2E0ZTc5MDk3YmRiNTc5MmQxYThmZDk0
+    MWNjZWZiMjUzZmZlNmJlMDRkNjEwMTBjMzA4N2ZlNzhhYzI4MDc=
+  data.tar.gz: !binary |-
+    YWIyOTU5NDBhMGM4NGQ3YzYyMDZjN2E1MWVjMDFiNzE0YzgyZDhmMTU1Zjcx
+    Y2M2YjA2OGRiZjk2OGM2YmU4NGVmYTVkYTU4ZWU4NTYwNGRlNWFmMzFkYTU5
+    N2MzYzkzZmY4MjRmNGUyY2NmOGEzMGFjYzkyOGI4MjU5ZjljOGU=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Convead
+
+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,121 @@
+# Ekam
+
+Простейший клиент для API сервиса ЕКАМ: 
+* https://www.ekam.ru/page/online-api
+* https://app.ekam.ru/online/swagger
+
+## Совместимость
+
+Клиент работает с версией ЕКАМ API v0.0.1
+
+## Установка
+
+Добавьте следующую строку в Gemfile вашего приложения:
+
+```
+gem 'ecwid_api'
+```
+
+Затем выполните команду:
+
+```
+$ bundle
+```
+
+Или установите gem самостоятельно:
+
+```
+$ gem install ecwid_api
+```
+
+## Примеры использования
+
+### Инициализация:
+
+```ruby
+require 'ekam-ruby'
+
+client = Ekam::Client.new(token)
+```
+
+Где `token` - авторизационный токен для вашего приложения ЕКАМ (подробнее тут: https://www.ekam.ru/page/online-api#creation).
+
+### Получение списка чеков
+
+```ruby
+# Получить все чеки без ограничений
+client.get_receipt_requests
+
+# Получить последние 10 чеков
+client.get_receipt_requests({limit: 10})
+
+# Получить только возвраты
+client.get_receipt_requests({type: 'returns'})
+
+# Получить все продажи в статусе "error"
+client.get_receipt_requests({type: 'sales', status: 'error'})
+
+# Получить чек по заказу с указанным ID
+order_id = '12345'
+client.get_receipt_requests({order_id: order_id})
+```
+
+### Регистрация чека (продажа)
+
+Описание параметров: https://www.ekam.ru/page/online-api#reg
+
+```ruby
+receipt_params = {
+  "order_id" => "91421af3",
+  "order_number" => "1014",
+  "type" => "sale",
+  "email" => "john@example.net",
+  "phone_number" => "79650000000",
+  "should_print" => true,
+  "cash_amount" => 201.1,
+  "electron_amount" => 0,
+  "lines" => [
+    {
+      "price" => 10,
+      "quantity" => 2,
+      "title"=> "Плюшевый мишка",
+      "total_price" => 20,
+      "vat_rate" => null
+    }
+  ]
+}
+
+client.create_receipt_request!(receipt_params)
+```
+
+### Регистрация чека (возврат)
+
+```ruby
+receipt_params = {
+  "order_id" => "91421af3",
+  "order_number" => "1014",
+  "type" => "return",
+  "email" => "john@example.net",
+  "phone_number" => "79650000000",
+  "should_print" => true,
+  "cash_amount" => 201.1,
+  "electron_amount" => 0,
+  "lines" => [
+    {
+      "price" => 10,
+      "quantity" => 2,
+      "title"=> "Плюшевый мишка",
+      "total_price" => 20,
+      "vat_rate" => null
+    }
+  ]
+}
+
+client.create_receipt_request!(receipt_params)
+```
+
+### Закрытие смены
+
+```ruby
+client.close_shift!
+```

data/ekam-ruby.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ekam-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ekam-ruby'
+  spec.version       = Ekam::VERSION
+  spec.authors       = ['Denis Lukyanov']
+  spec.email         = ['d.lukyanov@secoint.ru']
+  spec.summary       = 'Simple API client for EKAM'
+  spec.description   = 'Implementation of EKAM API v0.0.1 (https://app.ekam.ru/online/swagger)'
+  spec.homepage      = 'https://github.com/secoint/ekam-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.11'
+  
+  spec.add_development_dependency 'bundler', '~> 1.0'
+end

data/lib/ekam-ruby.rb

@@ -0,0 +1,3 @@
+require "ekam-ruby/version"
+require "ekam-ruby/client"
+require "ekam-ruby/error"

data/lib/ekam-ruby/client.rb

@@ -0,0 +1,60 @@
+require 'uri'
+require 'httparty'
+
+module Ekam
+  class Client
+    include HTTParty
+
+    base_uri "https://app.ekam.ru/api/online"
+
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def get_receipt_requests(params = {})
+      resource_url = "/v1/receipt_requests"
+      get_resource(resource_url, params)["items"]
+    end
+
+    def create_receipt_request!(params)
+      resource_url = "/v1/receipt_requests"
+      post_resource(resource_url, params)
+    end
+
+    def close_shift!
+      resource_url = "/v1/receipt_requests/close_retail_shift"
+      post_resource(resource_url)
+    end
+
+    private
+
+    def post_resource(resource_url, params = {})
+      response = self.class.post(resource_url, body: params.to_json, headers: request_headers)
+      status = response.code
+      if status != 201
+        raise Ekam::Error.new(status, response["error"], params)
+      end
+      response
+    end
+
+    def get_resource(resource_url, params = {})
+      response = self.class.get(resource_url, query: params, headers: request_headers)
+      status = response.code
+      if status != 200
+        raise Ekam::Error.new(status, response["error"], params)
+      end
+      response
+    end
+
+    def request_headers
+      {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'X-Access-Token' => token
+      }      
+    end
+
+  end
+end

data/lib/ekam-ruby/error.rb

@@ -0,0 +1,12 @@
+module Ekam
+  class Error < StandardError
+    attr_reader :code, :error, :request_params
+
+    def initialize(code, error, request_params)
+      super "Ekam responded with status #{code} (#{error})"
+      @error = error
+      @code = code
+      @request_params = request_params
+    end
+  end
+end

data/lib/ekam-ruby/version.rb

@@ -0,0 +1,3 @@
+module Ekam
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: ekam-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Denis Lukyanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Implementation of EKAM API v0.0.1 (https://app.ekam.ru/online/swagger)
+email:
+- d.lukyanov@secoint.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- ekam-ruby.gemspec
+- lib/ekam-ruby.rb
+- lib/ekam-ruby/client.rb
+- lib/ekam-ruby/error.rb
+- lib/ekam-ruby/version.rb
+homepage: https://github.com/secoint/ekam-ruby
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Simple API client for EKAM
+test_files: []