orangedata 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f4b1c0d05572781e1ae1550991a896a7d81b9f2
-  data.tar.gz: c3773260bb588960809e57153343ff187bdd90f1
+  metadata.gz: f3b6d9355317d3e78b2221d312c41f88b239fb29
+  data.tar.gz: 9ae406eeec23d3445b59293bd932b883e554f60e
 SHA512:
-  metadata.gz: 0fa8f50e4f9326ffca33ef0a5841cacbe2cc32a2573a6f380c47159aa9c8c21a9246a970cbc85dbad0ae6d9a0eb858eef1bb4eadfc2d6c55e551a90a7f41d40b
-  data.tar.gz: 8527fb6abb8a3a7bb0c9eb2aecbc40b239141b0517738091a01ab7d87e193abbd486b8eb2587f9cf52832ed43cd0afeb5530236a377b2d1fcc76b57e3b95922a
+  metadata.gz: 65ed68e2a634ec632e316f1ea4f180b7dbc19d2fb7770ddf7a541d48a6a6470a09855911162d0dd295f0ac0b3fe0efa50cee58cfbf4e796c96dd6dd9dddd77ea
+  data.tar.gz: 6816521a818a22ffadbea061198c0c0b79a7a07e06aff1cd2f86cea2f45fc3eba6a37f88cc15a4f5aa6c828eefaf01bb5a9a6595b202a3ff07e0052f80bca22d

data/.rubocop.yml

@@ -76,7 +76,7 @@ Layout/DotPosition:
   # so that code can be copied to console
   EnforcedStyle: trailing
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Layout/EmptyLines:

data/.travis.yml

@@ -3,6 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.1
-  - 2.4.1
+  - 2.3
+  - 2.5
+  - 2.6
 before_install: gem install bundler -v 1.16.6

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.0.6
+
+- data schema changes:
+  - title attribute used for field names instead of description
+  - printable field names in `print` attribute
+
+- Added: `set_agent_info`
+- Added: for development: `rake swagger:diff` to detect upstream schema changes
+- Changed: methods now return a wrapped result
+- Fixed: key loading now works on ruby 2.5+ (#1)

data/Gemfile.lock

@@ -1,70 +1,68 @@
 PATH
   remote: .
   specs:
-    orangedata (0.0.5)
+    orangedata (0.0.6)
       faraday (>= 0.15)
       faraday_middleware
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.1)
-    faraday (0.15.3)
+    docile (1.3.2)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
+    faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
-    hashdiff (0.3.7)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
+    hashdiff (0.4.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    multipart-post (2.0.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    multipart-post (2.1.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.57.2)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
-    webmock (3.4.2)
+    unicode-display_width (1.6.0)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -80,4 +78,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -7,28 +7,26 @@
 A ruby client for orangedata.ru service.
 Target service is pretty local to RU, so parts of readme will be in russian.
 
-Note: This is a Work-in-progress. API might change in the future.
+Ruby-клиент для сервиса онлайн-касс OrangeData
 
 Умеет:
 - собственно транспорт с подписью запросов
 - сгенерировать ключ сразу в нужном виде
 - маппинг для данных генерируется на базе приведенного в человеческий вид официального json-schema-описания
 
+В планах получше подружить с рельсами.
+
+На всякий случай disclaimer: API еще не полностью устоялось и возможно будет обновляться по мере обкатки.
+
 ## Установка
 
-Все стандартно. Пишем в Gemfile:
+Все стандартно - `bundle add orangedata`, либо по-старике пишем в Gemfile:
 
 ```ruby
 gem 'orangedata'
 ```
 
-И давим:
-
-    $ bundle
-
-Либо руками:
-
-    $ gem install orangedata
+и давим `bundle`. Совсем руками можно `gem install orangedata`
 
 ## Использование
 
@@ -37,6 +35,12 @@ gem 'orangedata'
 
 ### Пробитие чека
 
+Описание полей смотреть в [официальной документации](https://github.com/orangedata-official/API), названия маппинга и некоторые коментарии есть [в схеме данных](lib/orange_data/schema_definitions.yml) (метасхема расширений [тут](spec/lib/extensions_metaschema.yml)).
+
+Для `enum`-полей есть маппинг, например `content.positions[0].tax` принимает значения: `:vat_18`, `:vat_10`, `:vat_18_118`, `:vat_10_110`, `:vat_0`, `:vat_not_charged`.
+
+Простейший чек в тестовом окружении:
+
 ```ruby
   transport = OrangeData::Transport.new("https://apip.orangedata.ru:2443/api/v2/", OrangeData::Credentials.default_test)
   receipt = OrangeData::Receipt.income(inn:"1234567890"){|r|
@@ -82,9 +86,9 @@ gem 'orangedata'
 ```
 
 ### Чек коррекции
-Пока не понятно, почему в API не все значения поля tax соответствуют цифрам в `taxNSum`, поэтому коррекцию, видимо, лучше бить через саппорт или подобным образом.
+Осторожно: в API не все значения поля `tax` соответствуют цифрам в `taxNSum`, поддержка OD ответила, что все ок, так и должно быть. Скорее всего непонятки с номерами налогов приехали еще из налоговой, т.к. номера тегов тут идут подряд.
 
-Но поддержка в маппинге есть:
+Поэтому в маппинге есть алиасы:
 
 ```ruby
 transport = OrangeData::Transport.new("https://apip.orangedata.ru:2443/api/v2/", OrangeData::Credentials.default_test)

data/Rakefile

@@ -6,3 +6,49 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+
+namespace :swagger do
+  swagger_file_name = 'tmp/swagger.json'
+
+  task :environment do
+    require 'json'
+    require 'orangedata'
+  end
+
+  file swagger_file_name => :environment do
+    puts "Downloading swagger.json"
+    `curl https://apip.orangedata.ru:2443/swagger/v2/swagger.json > #{swagger_file_name}`
+  end
+
+  task diff: [:environment, swagger_file_name] do
+    swagger = JSON.parse(File.read(swagger_file_name))
+
+    new_definitions = swagger['definitions']
+    old_definitions = OrangeData::PAYLOAD_SCHEMA['definitions']
+
+    if new_definitions.keys != old_definitions.keys
+      puts "New schema definitions: #{new_definitions.keys - old_definitions.keys}"
+      puts "Removed schema definitions: #{old_definitions.keys - new_definitions.keys}"
+    else
+      puts "No top-level definitions changed"
+    end
+
+    new_definitions.each_pair do|key, new_schema|
+      old_schema = old_definitions[key]
+      next unless old_schema
+
+      if old_schema['properties'].keys != new_schema['properties'].keys
+        if old_schema['properties'].keys.sort != new_schema['properties'].keys.sort
+          puts "\t#{key} added: #{new_schema['properties'].keys - old_schema['properties'].keys}"
+          puts "\t#{key} removed: #{old_schema['properties'].keys - new_schema['properties'].keys}"
+        else
+          puts "\t#{key} property order changed"
+        end
+      else
+        #TODO: deep compare
+      end
+    end
+
+  end
+end

data/lib/orange_data/credentials.rb

@@ -44,9 +44,37 @@ module OrangeData
 
         def from_hash(hash)
           OpenSSL::PKey::RSA.new.tap do |key|
-            key.params.keys.each do |param|
-              if (v = hash[param] || hash[param.to_sym])
-                key.send(:"#{param}=", OpenSSL::BN.new(Base64.decode64(v), 2))
+            if key.respond_to?(:set_key)
+              # ruby 2.5+
+              # a bit ugly - simulating with_indifferent_access
+              if hash['n'] || hash[:n]
+                # public key only has n and e (without them - there's no key actually)
+                key.set_key(
+                  OpenSSL::BN.new(Base64.decode64(hash['n'] || hash[:n]), 2),
+                  OpenSSL::BN.new(Base64.decode64(hash['e'] || hash[:e]), 2),
+                  (hash['d'] || hash[:d]) && OpenSSL::BN.new(Base64.decode64(hash['d'] || hash[:d]), 2)
+                )
+              end
+
+              if hash['p'] || hash[:p]
+                key.set_factors(
+                  OpenSSL::BN.new(Base64.decode64(hash['p'] || hash[:p]), 2),
+                  OpenSSL::BN.new(Base64.decode64(hash['q'] || hash[:q]), 2)
+                )
+                if hash['dmp1'] || hash[:dmp1]
+                  key.set_crt_params(
+                    OpenSSL::BN.new(Base64.decode64(hash['dmp1'] || hash[:dmp1]), 2),
+                    OpenSSL::BN.new(Base64.decode64(hash['dmq1'] || hash[:dmq1]), 2),
+                    OpenSSL::BN.new(Base64.decode64(hash['iqmp'] || hash[:iqmp]), 2)
+                  )
+                end
+              end
+            else
+              # ruby 2.3 and may be older
+              key.params.keys.each do |param|
+                if (v = hash[param] || hash[param.to_sym])
+                  key.send(:"#{param}=", OpenSSL::BN.new(Base64.decode64(v), 2))
+                end
               end
             end
           end

data/lib/orange_data/generated_attributes.rb

@@ -110,6 +110,10 @@ module OrangeData
       self
     end
 
+    def attributes
+      to_hash.map{|(k,v)| [k.underscore, v] }.to_h
+    end
+
     def ==(other)
       self.class == other.class && to_hash == other.to_hash
       # @payload == other.instance_variable_get(:@payload)

data/lib/orange_data/receipt.rb

@@ -95,7 +95,11 @@ module OrangeData
       @additional_user_attribute = AdditionalUserAttribute.new.assign_attributes(options)
     end
 
-
+    def set_agent_info(**options)
+      # agent info may have some validations/transformations, so
+      agent_info = AgentInfo.new.assign_attributes(options)
+      assign_attributes(agent_info.attributes.reject{|_k,v| v.nil?})
+    end
 
     class Position < PayloadContent
       def initialize(payload={})
@@ -182,6 +186,7 @@ module OrangeData
 
     def qr_code_content
       # Пример: t=20150720T1638&s=9999999.00&fn=000110000105&i=12345678&fp=123456&n=2
+      # вообще это тег 1196, но OD его не присылают
       {
         # - t=<date/time - дата и время осуществления расчета в формате ГГГГММДДТЧЧММ>
         t: processed_at.gsub(/:\d{2}\z/, '').gsub(/[^0-9T]/, ''),