hik_openapi 0.1.2 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8dfc6814b2cc4c658722f6ff00dbb37eca887895ac9dad161204090908594ad
-  data.tar.gz: d3d66653342ad868ea0c555298ba4c5b4fb03c5e25454b6ed8ca60b59855c52e
+  metadata.gz: 124810a1613f0b8e8ae9491dd535697611763308962dc61dd9dc07ddb62d4a9a
+  data.tar.gz: fe2cbb8f1f6f87b607bc5ce1c1886c9d28553b47593a50af7e0f5ba7e73b77bf
 SHA512:
-  metadata.gz: d79392c09b986e6f85a86dc7c42558bbc5b01707c8d7d162d061bca66b7b3d95b757f29186c2a92ddd7f0e5e601ed1b8b44e4404c5e640e5784a9477cc3f8ebc
-  data.tar.gz: 46aecdb8520b6580c99adaaff7e41a240270bf153cec2f3c170865537d71ac4e9b4627d4153c362c9e59c365cf3cbffb4520ca4caa12cd00340eed6eb477ccb9
+  metadata.gz: a7f1722cf24803942375ffc473416d40d2dee05e5e4918948b65ef635bf8d7475967c1831d77573338e607f30a5ec566f685bafd5cec9e010591987ea09cc2df
+  data.tar.gz: b2d14d7d2419a793c9b5d05ead14adf205a241afc81ef3427f35c6d382d40633ecde524341cdfa212a47a41fc87df79e6efd20cedb68575d921d3d5db06f346e

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+hik_openapi-*.gem

data/.rubocop.yml

@@ -0,0 +1,67 @@
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.4
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/Void:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 36
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 10
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/ParameterLists:
+  Max: 5
+  MaxOptionalParameters: 5
+  CountKeywordArgs: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    map:      'collect'
+    map!:     'collect!'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: 'comma'
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: 'comma'

data/Gemfile

@@ -1,7 +1,12 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in hik_openapi.gemspec
-gemspec
+gem 'rake', '~> 12.0'
+
+group :development, :test do
+  gem 'pry'
+  gem 'guard-rspec', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+end
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gemspec

data/Gemfile.lock

@@ -1,13 +1,71 @@
 PATH
   remote: .
   specs:
-    hik_openapi (0.1.2)
+    hik_openapi (0.2)
+      http (~> 4.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.0)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    listen (3.5.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -21,14 +79,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard-rspec
   hik_openapi!
+  pry
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/rest/(.+)\.rb$}) { |m| "spec/lib/rest/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/README.md

@@ -1,37 +1,22 @@
-# HikOpenapi
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hik_openapi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'hik_openapi'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install hik_openapi
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hik_openapi.
+```ruby
+@client = HikOpenapi::Client.new do |config|
+  config.host = "https://192.168.3.230"
+  config.prefix = "/artemis"
+  config.app_key = "app_key"
+  config.app_secret = "app_secret"
+  config.proxy = { host: "127.0.0.1", port: 8123 } if Rails.env.development?
+end
+
+params = {
+  'cameraIndexCode': [url],
+  'streamType':      0,
+  'protocol':        [video_type],
+  'transmode':       0,
+  'expand':          "transcode=0",
+}
+
+res = @client.post("/api/video/v1/cameras/previewURLs", params)
 
-# hik_openapi
+```

data/hik_openapi.gemspec

@@ -1,6 +1,8 @@
 require_relative 'lib/hik_openapi/version'
 
 Gem::Specification.new do |spec|
+  spec.add_dependency 'http', '~> 4.4.1'
+
   spec.name          = 'hik_openapi'
   spec.version       = HikOpenapi::VERSION
   spec.authors       = ['palytoxin']
@@ -9,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'hikvision openapi for ruby.'
   spec.description   = 'hikvision openapi for ruby.'
   spec.homepage      = 'https://github.com/palytoxin/hik_openapi'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -17,12 +19,8 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/palytoxin/hik_openapi'
   spec.metadata['changelog_uri'] = 'https://github.com/palytoxin/hik_openapi'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 end

data/lib/hik_openapi.rb

@@ -1,25 +1,96 @@
 # frozen_string_literal: true
 
 require 'hik_openapi/version'
-require 'hik_openapi/configuration'
-require 'hik_openapi/api'
-require 'hik_openapi/result'
+require 'securerandom'
+require 'openssl'
+require 'http'
 
 module HikOpenapi
-  class Error < StandardError; end
+  class Client
+    attr_accessor :host, :prefix, :app_key, :app_secret, :proxy, :timeouts
+    attr_writer :user_agent
 
-  def self.config
-    return @config if defined?(@config)
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
 
-    @config = Configuration.new
-    @config
-  end
+    def get(path, params)
+      request(:get, path, params)
+    end
 
-  def self.setup
-    yield config
-  end
+    def post(path, params)
+      request(:post, path, params)
+    end
+
+    private
+
+    def request(request_method, path, params)
+      @uri = host + prefix + path
+      @request_method = request_method
+      @path = path
+      @params = params
+      @options_key = {get: :params, post: :json}[request_method] || :form
+      @headers = {'Content-Type': 'application/json', 'Accept': '*/*', 'x-ca-timestamp': (Time.now.to_f * 1000).to_i.to_s, 'x-ca-nonce': SecureRandom.uuid, 'x-ca-key': app_key}
+      perform
+    end
+
+    def perform
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      response = http_client.headers(sign_headers(@headers)).public_send(@request_method, @uri.to_s, request_options.merge(ssl_context: ctx))
+      response_body = response.body.empty? ? '' : symbolize_keys!(response.parse)
+      response_headers = response.headers
+      {
+        headers: response_headers,
+        body: response_body,
+      }
+    end
+
+    def symbolize_keys!(object)
+      case object
+      when Array
+        object.each_with_index { |val, index| object[index] = symbolize_keys!(val) }
+      when Hash
+        object.dup.each_key { |key| object[key.to_sym] = symbolize_keys!(object.delete(key)) }
+      end
+      object
+    end
+
+    def timeout_keys_defined
+      (%i[write connect read] - (timeouts&.keys || [])).empty?
+    end
+
+    def http_client
+      client = proxy ? HTTP.via(*proxy.values_at(:host, :port, :username, :password).compact) : HTTP
+      client = client.timeout(connect: timeouts[:connect], read: timeouts[:read], write: timeouts[:write]) if timeout_keys_defined
+      client
+    end
+
+    def request_options
+      {@options_key => @params}
+    end
+
+    def sign_headers(headers)
+      headers.merge!({
+                       "x-ca-signature": sign(@request_method, (prefix + @path), headers),
+                     })
+    end
+
+    def sign(method, path, headers)
+      sign_str = headers.reject { |a| a.to_s.start_with?('x-ca') }.values.sort
+      sign_str = sign_str.unshift(method.to_s.upcase).push(path).join("\n")
 
-  def self.api
-    Api
+      Base64.encode64(
+        OpenSSL::HMAC.digest(
+          OpenSSL::Digest.new('sha256'),
+          app_secret,
+          sign_str
+        )
+      ).strip
+    end
   end
 end

data/lib/hik_openapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HikOpenapi
-  VERSION = '0.1.2'
+  VERSION = '0.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hik_openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '0.2'
 platform: ruby
 authors:
 - palytoxin
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
-dependencies: []
+date: 2021-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
 description: hikvision openapi for ruby.
 email:
 - sxty32@gmail.com
@@ -19,16 +33,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - README.md
 - Rakefile
 - hik_openapi.gemspec
 - lib/hik_openapi.rb
-- lib/hik_openapi/api.rb
-- lib/hik_openapi/configuration.rb
-- lib/hik_openapi/result.rb
 - lib/hik_openapi/version.rb
 homepage: https://github.com/palytoxin/hik_openapi
 licenses: []
@@ -45,14 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: hikvision openapi for ruby.

data/lib/hik_openapi/api.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'json'
-require 'base64'
-require 'uri'
-require 'securerandom'
-require 'openssl'
-
-module HikOpenapi
-  module Api
-    class << self
-      def get
-        # TODO
-        puts 'WIP'
-      end
-
-      def post(path, body)
-        uri = URI(HikOpenapi.config.host)
-        uri.merge!(path)
-
-        https = Net::HTTP.new(uri.host, uri.port)
-        https.use_ssl = true
-        https.open_timeout = 10
-        https.read_timeout = 10
-        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        headers = init_header('POST', uri.path)
-        # headers.transform_values! { |v| v.force_encoding('iso-8859-1') }
-
-        begin
-          request = Net::HTTP::Post.new(uri.request_uri, headers)
-          request.body = body.to_json
-          res = https.request(request)
-
-          result = HikOpenapi::Result.new
-          result.code = res.code
-          result.body = JSON.parse(res.body.force_encoding('utf-8'))
-          result.origin = res
-          result
-        rescue StandardError => e
-          result = HikOpenapi::Result.new
-          result.error = HikOpenapi::Error.new(e)
-          result
-        end
-      end
-
-      private
-
-      def init_header(method, path)
-        headers = {
-          'Content-Type': 'application/json',
-          "Accept": '*/*',
-          'x-ca-timestamp': (Time.now.to_f * 1000).to_i.to_s,
-          'x-ca-nonce': SecureRandom.uuid,
-          'x-ca-key': HikOpenapi.config.app_key
-        }
-
-        headers.merge({
-                        "x-ca-signature": sign(method, path, headers)
-                      })
-      end
-
-      def sign(method, path, headers)
-        sign_str = headers.reject { |a| a.to_s.start_with?('x-ca') }.values.sort
-        sign_str = sign_str.unshift(method).push(path).join("\n")
-
-        enc = Base64.encode64(
-          OpenSSL::HMAC.digest(
-            OpenSSL::Digest.new('sha256'),
-            HikOpenapi.config.app_secret,
-            sign_str
-          )
-        ).strip
-        enc
-      end
-    end
-  end
-end

data/lib/hik_openapi/configuration.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module HikOpenapi
-  class Configuration
-    attr_accessor :host
-    attr_accessor :app_key
-    attr_accessor :app_secret
-  end
-end

data/lib/hik_openapi/result.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module HikOpenapi
-  class Result
-    attr_accessor :code
-    attr_accessor :body
-    attr_accessor :origin
-    attr_accessor :error
-  end
-end