orangedata 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f3b6d9355317d3e78b2221d312c41f88b239fb29
-  data.tar.gz: 9ae406eeec23d3445b59293bd932b883e554f60e
+SHA256:
+  metadata.gz: 8af88534119802c5e031fff99d54faeda092ed09f35c220b6c298330a733c9a8
+  data.tar.gz: 63b7bac4c5594d2f4d90eb8243b5179977c434ab1b47691878d5c3313e0d25c7
 SHA512:
-  metadata.gz: 65ed68e2a634ec632e316f1ea4f180b7dbc19d2fb7770ddf7a541d48a6a6470a09855911162d0dd295f0ac0b3fe0efa50cee58cfbf4e796c96dd6dd9dddd77ea
-  data.tar.gz: 6816521a818a22ffadbea061198c0c0b79a7a07e06aff1cd2f86cea2f45fc3eba6a37f88cc15a4f5aa6c828eefaf01bb5a9a6595b202a3ff07e0052f80bca22d
+  metadata.gz: 9f534d7ef8d02e88bb6cfe9fb28deaa66c51d745bc6681d158c127d314854f1878e9e1372e3511a21d81d9d243d960dfb7f8b4e9954afadf926e32090fe6629a
+  data.tar.gz: '09d9ae86ca7bfd561b9ab5b5bbe8b8c1a09bab0a6986efc41caf732ea1b8fe1a75f98a263d4b1de666d59dc1f2f7701f62f588b9596beea2548fcf592791071d'

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 /.rspec_status
 /*.yml
+.DS_Store

data/.rubocop.yml

@@ -10,7 +10,7 @@ Gemspec/RequiredRubyVersion:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 120
+  Max: 130
   Exclude:
     - 'spec/**/*'
 
@@ -19,6 +19,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
+Metrics/BlockNesting:
+  Max: 4
+
 Metrics/MethodLength:
   Max: 20
   Enabled: false
@@ -36,6 +39,9 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 50
 
+Metrics/ParameterLists:
+  Max: 10
+
 Style/StringLiterals:
   Enabled: false
   # EnforcedStyle: double_quotes
@@ -43,6 +49,9 @@ Style/StringLiterals:
 Style/RedundantReturn:
   Enabled: false
 
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+
 Layout/SpaceBeforeBlockBraces:
   EnforcedStyle: no_space
 
@@ -99,3 +108,6 @@ Style/TrailingCommaInHashLiteral:
   Enabled: false
 Style/TrailingCommaInArrayLiteral:
   Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.0.7
+
+- data schema update to 2.23.0 (15.06.2019)
+- Added: load credentials from zip file via rubyzip (no dependency, only accept already opened object)
+- Added: Credentials#from_hash now accepts `key_pass` argument
+
 # 0.0.6
 
 - data schema changes:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orangedata (0.0.6)
+    orangedata (0.0.7)
       faraday (>= 0.15)
       faraday_middleware
 
@@ -52,6 +52,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    rubyzip (1.2.3)
     safe_yaml (1.0.5)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -74,6 +75,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec
   rubocop
+  rubyzip
   simplecov
   webmock
 

data/README.md

@@ -142,6 +142,14 @@ res = transport.get_correction(correction.inn, correction.id)
   transport.post_document # и далее по тексту, осторожно - не пробейте лишние чеки во время проверок
 ```
 
+Еще есть `OrangeData::Credentials.read_certs_from_zip_pack`, куда можно скормить нераспакованный файлик, если у вас есть `gem 'rubyzip'`:
+
+```ruby
+  c = Zip::File.open("cert_123.zip") do |zip_file|
+    OrangeData::Credentials.read_certs_from_zip_pack(zip_file, cert_key_pass:'1234')
+  end
+```
+
 ## Разработка
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -34,7 +34,7 @@ namespace :swagger do
       puts "No top-level definitions changed"
     end
 
-    new_definitions.each_pair do|key, new_schema|
+    new_definitions.each_pair do |key, new_schema|
       old_schema = old_definitions[key]
       next unless old_schema
 
@@ -43,12 +43,13 @@ namespace :swagger do
           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"
+          puts "\t#{key} property order changed:"
+          puts "\t\told:#{old_schema['properties'].keys}"
+          puts "\t\tnew:#{new_schema['properties'].keys}"
         end
-      else
-        #TODO: deep compare
+        # else
+        # TODO: deep compare
       end
     end
-
   end
 end

data/lib/orange_data/credentials.rb

@@ -33,9 +33,16 @@ module OrangeData
           raise ArgumentError, 'no RSAKeyValue in xml' unless kv && kv.name == 'RSAKeyValue'
 
           mapping = {
-            "Modulus"=>:n, "Exponent"=>:e,
-            "D"=>:d, "P"=>:p, "Q"=>:q,
-            "DP"=>:dmp1, "DQ"=>:dmq1, "InverseQ"=>:iqmp
+            "Modulus" => :n,
+            "Exponent" => :e,
+
+            "D" => :d,
+            "P" => :p,
+            "Q" => :q,
+
+            "DP" => :dmp1,
+            "DQ" => :dmq1,
+            "InverseQ" => :iqmp
           }
           from_hash(
             kv.elements.each_with_object({}){|k, h| h[mapping[k.name]] = k.text if mapping[k.name] }
@@ -82,6 +89,7 @@ module OrangeData
 
         def load_from(val, key_pass=nil)
           return val unless val
+
           case val
           when self
             val
@@ -97,9 +105,7 @@ module OrangeData
             raise ArgumentError, "cannot load from #{val.class}"
           end
         end
-
       end
-
     end
 
     using KeyEncoding
@@ -109,6 +115,7 @@ module OrangeData
     def initialize(signature_key_name:nil, signature_key:nil, certificate:nil, certificate_key:nil, title:nil)
       raise ArgumentError, "Signature key should be a private key" if signature_key && !signature_key.private?
       raise ArgumentError, "Certificate key should be a private key" if certificate_key && !certificate_key.private?
+
       @signature_key_name = signature_key_name
       @signature_key = signature_key
       @certificate = certificate
@@ -126,6 +133,7 @@ module OrangeData
 
     def ==(other)
       return false unless %i[signature_key_name title].all?{|m| send(m) == other.send(m) }
+
       # certificates/keys cannot be compared directly, so dump
       %i[signature_key certificate certificate_key].all?{|m|
         c1 = send(m)
@@ -134,13 +142,14 @@ module OrangeData
       }
     end
 
-    def self.from_hash(creds)
+    def self.from_hash(creds, key_pass:nil)
+      key_pass ||= '' # to prevent password prompt, works in fresh openssl gem/ruby
       new(
         title: creds[:title],
         signature_key_name: creds[:signature_key_name],
-        signature_key: OpenSSL::PKey::RSA.load_from(creds[:signature_key], creds[:signature_key_pass]),
+        signature_key: OpenSSL::PKey::RSA.load_from(creds[:signature_key], creds[:signature_key_pass] || key_pass),
         certificate: creds[:certificate] && OpenSSL::X509::Certificate.new(creds[:certificate]),
-        certificate_key: OpenSSL::PKey::RSA.load_from(creds[:certificate_key], creds[:certificate_key_pass])
+        certificate_key: OpenSSL::PKey::RSA.load_from(creds[:certificate_key], creds[:certificate_key_pass] || key_pass)
       )
     end
 
@@ -204,6 +213,7 @@ module OrangeData
 
     def self.generate_signature_key(key_length=DEFAULT_KEY_LENGTH)
       raise ArgumentError, "key length should be >= 489, recomended #{DEFAULT_KEY_LENGTH}" unless key_length >= 489
+
       OpenSSL::PKey::RSA.new(key_length)
     end
 
@@ -211,6 +221,7 @@ module OrangeData
       path = File.expand_path(path)
       client_cert = Dir.glob(path + '/*.{crt}').select{|f| File.file?(f.sub(/.crt\z/, '.key')) }
       raise 'Expect to find exactly one <num>.crt with corresponding <num>.key file' unless client_cert.size == 1
+
       client_cert = client_cert.first
 
       unless signature_key
@@ -234,6 +245,34 @@ module OrangeData
       )
     end
 
+    def self.read_certs_from_zip_pack(rubyzip_object, signature_key_name:nil, cert_key_pass:nil, title:nil, signature_key:nil)
+      client_cert = rubyzip_object.glob("*.crt").select{|f| rubyzip_object.glob(f.name.sub(/.crt\z/, '.key')).any? }
+      raise 'Expect to find exactly one <num>.crt with corresponding <num>.key file' unless client_cert.size == 1
+
+      client_cert = client_cert.first
+      client_key = rubyzip_object.glob(client_cert.name.sub(/.crt\z/, '.key')).first
+
+      unless signature_key
+        # private_key_test.xml || rsa_\d+_private_key.xml
+        xmls = rubyzip_object.glob('/*.{xml}').select{|f| f =~ /private/ }
+        signature_key = if xmls.size == 1
+          xmls.first.get_input_stream.read
+        else
+          generate_signature_key(DEFAULT_KEY_LENGTH)
+          # .tap{|k| logger.info("Generated public signature key: #{k.public_key.to_xml}") }
+        end
+      end
+
+      from_hash(
+        title: title || "Generated from zip",
+        signature_key_name: signature_key_name || File.basename(client_cert.name).gsub(/\..*/, ''),
+        certificate: client_cert.get_input_stream.read,
+        certificate_key: client_key.get_input_stream.read,
+        certificate_key_pass: cert_key_pass,
+        signature_key: signature_key
+      )
+    end
+
     # публичная часть ключа подписи в формате пригодном для отдачи в ЛК
     def signature_public_xml
       signature_key.public_key.to_xml

data/lib/orange_data/generated_attributes.rb

@@ -10,7 +10,7 @@ module OrangeData
     module StringExt
       refine String do
         def underscore
-          self.gsub(/::/, '/').
+          gsub(/::/, '/').
             gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
             gsub(/([a-z\d])([A-Z])/, '\1_\2').
             tr("-", "_").
@@ -30,25 +30,32 @@ module OrangeData
     end
 
     protected
+
     def generate_accessors_from_schema(schema)
       plain_types = %w[integer string number]
       schema["properties"].each_pair do |property, info|
         property_name = info["x-name"] || property.underscore
 
-        if plain_types.include?(info["type"])
+        if plain_types.include?(info["type"]) ||
+           info["type"].is_a?(Array) && plain_types.include?(info["type"].first) &&
+           info["type"].last == "null" && info["type"].size == 2
           if info["x-enum"]
             inverse_map = info["x-enum"].map{|k, v| [v['val'], k.to_sym] }.to_h
+
             define_method(property_name){
               return nil if @payload[property].nil?
+
               inverse_map[@payload[property]] ||
                 raise("unknown value #{@payload[property].inspect} for field #{property}")
             }
             define_method(:"#{property_name}="){|val|
               unless val.nil?
-                val = (info["x-enum"][val.to_s] ||
+                val = (
+                  info["x-enum"][val.to_s] ||
                   raise(ArgumentError, "unknown value #{val.inspect} for property #{property}")
                 )["val"]
               end
+
               @payload[property] = val
             }
 
@@ -57,6 +64,7 @@ module OrangeData
             # TODO: return wrapper so that :<< etc will work
             define_method(property_name){
               return nil if @payload[property].nil?
+
               data = @payload[property].to_i
               # FIXME: unknown bits will be silently lost
               bitmap.reject{|_, v| (data & v).zero? }.map(&:first)
@@ -64,7 +72,9 @@ module OrangeData
             define_method(:"#{property_name}="){|val|
               unless val.nil?
                 val = [val] unless val.is_a?(Array)
-                val = val.map{|v| bitmap[v] || raise(ArgumentError, "unknown value #{v.inspect} for property #{property}") }.reduce(:|)
+                val = val.map{|v|
+                  bitmap[v] || raise(ArgumentError, "unknown value #{v.inspect} for property #{property}")
+                }.reduce(:|)
               end
               @payload[property] = val
             }
@@ -80,15 +90,16 @@ module OrangeData
               val = [val] unless val.is_a?(Array)
               @payload[property] = val
             }
-          else
+            # else
             # ref?
           end
-        else
+
+          # else
 
         end
 
         if info["x-alias"]
-          alias_method "#{info['x-alias']}", property_name
+          alias_method info['x-alias'].to_s, property_name
           alias_method "#{info['x-alias']}=", "#{property_name}="
         end
       end
@@ -111,7 +122,7 @@ module OrangeData
     end
 
     def attributes
-      to_hash.map{|(k,v)| [k.underscore, v] }.to_h
+      to_hash.map{|(k, v)| [k.underscore, v] }.to_h
     end
 
     def ==(other)

data/lib/orange_data/receipt.rb

@@ -11,14 +11,15 @@ module OrangeData
   # main class for receipt/correction
   class Document
 
-    attr_accessor :id, :inn, :group, :key_name, :content
+    attr_accessor :id, :inn, :group, :key_name, :content, :callback_url
 
-    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil)
+    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil, callback_url: nil)
       @id = id
       @inn = inn
       @group = group
       @key_name = key_name || inn
       @content = content if content
+      @callback_url = callback_url
       yield @content if block_given?
     end
 
@@ -29,12 +30,14 @@ module OrangeData
         group: group || 'Main',
         content: content,
         key: key_name
+      }.tap{|h|
+        h[:callbackUrl] = @callback_url if @callback_url
       }.to_json(*args)
     end
   end
 
   class Receipt < Document
-    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil)
+    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil, callback_url: nil)
       @content = ReceiptContent.new(content || {})
       super
     end
@@ -53,10 +56,11 @@ module OrangeData
       # TODO: import...
       # TODO: taxationSystem default in checkclose
       @check_close = CheckClose.new(@payload['checkClose'])
-      @positions = (@payload['positions'] || []).map{|pos| Position.new(pos) }
       if @payload["additionalUserAttribute"]
         @additional_user_attribute = AdditionalUserAttribute.new(@payload["additionalUserAttribute"])
       end
+
+      @positions = (@payload['positions'] || []).map{|pos| Position.new(pos) }
     end
 
     # сырой тип используется в qr_code
@@ -98,7 +102,7 @@ module OrangeData
     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?})
+      assign_attributes(agent_info.attributes.reject{|_k, v| v.nil? })
     end
 
     class Position < PayloadContent
@@ -178,6 +182,7 @@ module OrangeData
 
     def self.from_hash(hash)
       raise ArgumentError, 'Expect hash here' unless hash.is_a?(Hash)
+
       new(hash)
     end
 
@@ -207,7 +212,7 @@ module OrangeData
   # Correction
 
   class Correction < Document
-    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil)
+    def initialize(id:SecureRandom.uuid, inn:, group:nil, key_name:nil, content:nil, callback_url: nil)
       @content = CorrectionContent.new(content || {})
       super
     end
@@ -232,6 +237,7 @@ module OrangeData
 
     def self.from_hash(hash)
       raise ArgumentError, 'Expect hash here' unless hash.is_a?(Hash)
+
       new(hash)
     end
 

data/lib/orange_data/schema_definitions.yml

@@ -42,6 +42,10 @@ definitions:
       content:
         title: Содержимое документа
         "$ref": "#/definitions/CheckContent"
+      callbackUrl:
+        description: URL для отправки результатов обработки чека POST запросом
+        type: [string, "null"]
+        maxLength: 1024
 
 
   CheckContent:
@@ -361,15 +365,15 @@ definitions:
         format: byte
         minLength: 1
         maxLength: 32
+      supplierINN:
+        title: ИНН поставщика
+        x-tag-id: 1226
+        type: string
       supplierInfo:
         "$ref": "#/definitions/SupplierInfo"
         title: Данные поставщика
         nullable: true
         x-tag-id: 1224
-      supplierINN:
-        title: ИНН поставщика
-        x-tag-id: 1226
-        type: string
       agentType:
         x-tag-id: 1222
         x-todo: DRY 1057?
@@ -613,6 +617,11 @@ definitions:
         type: string
       content:
         "$ref": "#/definitions/CorrectionContent"
+      callbackUrl:
+        description: URL для отправки результатов обработки чека POST запросом
+        type: [string, "null"]
+        maxLength: 1024
+
 
 
   CorrectionContent:
@@ -833,6 +842,11 @@ definitions:
       fp:
         title: Фискальный признак
         type: string
+      callbackUrl:
+        description: URL для отправки результатов обработки чека POST запросом
+        type: [string, "null"]
+        maxLength: 1024
+
 
 
   CheckStatusViewModel[CorrectionContent]:
@@ -902,3 +916,8 @@ definitions:
         title: Фискальный признак
         type: string
         maxLength: 10
+      callbackUrl:
+        description: URL для отправки результатов обработки чека POST запросом
+        type: [string, "null"]
+        maxLength: 1024
+

data/lib/orange_data/transport.rb

@@ -14,6 +14,7 @@ module OrangeData
 
     def initialize(api_url=DEFAULT_TEST_API_URL, credentials=Credentials.default_test)
       raise ArgumentError, "Need full credentials for connection" unless credentials.valid?
+
       @credentials = credentials
       @api_url = api_url
     end
@@ -92,15 +93,20 @@ module OrangeData
 
       def retry
         raise "not-retriable" unless should_retry?
-        @transport.post_entity(@sub_url, @data, raise_errors:false, result_class:self.class, retry_count:(retry_count + 1))
+
+        @transport.post_entity(@sub_url, @data,
+          raise_errors:false, result_class:self.class, retry_count:(retry_count + 1))
       end
 
       protected
-      def get_result_with get_method
+
+      def get_result_with(get_method)
         raise "Non-success" unless success?
-        @transport.send(get_method,
+
+        @transport.send(
+          get_method,
           @data.respond_to?(:inn) && @data.inn || @data[:inn] || @data["inn"],
-          @data.respond_to?(:id) && @data.id || @data[:id] || @data["id"],
+          @data.respond_to?(:id) && @data.id || @data[:id] || @data["id"]
         )
       end
     end
@@ -122,20 +128,32 @@ module OrangeData
 
       case res.status
       when 201
-        return result_class.new(success: true, data:data, sub_url:sub_url, retry_count:0, transport:self)
+        return result_class.new(success: true, data:data, sub_url:sub_url, retry_count:retry_count, transport:self)
       when 409
         raise "Conflict" if raise_errors
-        return result_class.new(data:data, sub_url:sub_url, errors:["Duplicate id"], retry_count:0)
+
+        return result_class.new(data:data, sub_url:sub_url, errors:["Duplicate id"], retry_count:retry_count)
       when 400
         raise "Invalid doc: #{res.body['errors'] || res.body}" if raise_errors
-        return result_class.new(data:data, sub_url:sub_url, errors:res.body['errors'], retry_count:0)
+
+        return result_class.new(data:data, sub_url:sub_url, errors:res.body['errors'], retry_count:retry_count)
       when 503
         if res.headers['Retry-After']
           raise "Document queue full, retry in #{res.headers['Retry-After']}" if raise_errors
-          return result_class.new(attempt_retry:true, retry_in:res.headers['Retry-After'].to_i, data:data, sub_url:sub_url, retry_count:0, transport:self)
+
+          return result_class.new(
+            attempt_retry: true,
+            retry_in: res.headers['Retry-After'].to_i,
+            data: data,
+            sub_url: sub_url,
+            retry_count: retry_count,
+            transport: self
+          )
         end
       end
+
       raise "Unknown code from OD: #{res.status} #{res.reason_phrase} #{res.body}" if raise_errors
+
       result_class.new(attempt_retry:true, data:data, sub_url:sub_url, retry_count:0, transport:self)
     end
 

data/lib/orange_data/version.rb

@@ -2,6 +2,6 @@
 
 module OrangeData
 
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 
 end

data/orangedata.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubyzip"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orangedata
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -185,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for orangedata.ru service