novaposhta_api 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0a59d6e83adee1e273164e0a7c3dc33828e2e0167451a4da1047dc88eaaf9e
-  data.tar.gz: 465497a98ad80b79aa90ee2722bfce629db455a7467f9e4f13a03bedef4ed79d
+  metadata.gz: '092ea7dd2a237106569b0c9d36739f1892f40d628b2599ab5dd0004f5c9f83af'
+  data.tar.gz: 38ef279dcdc0c6df731343772662824be10f3b6605368972037d818c004e3403
 SHA512:
-  metadata.gz: cf3b30451c7c21da4d71b7439f725c00b136c6240816501cb808b83ce738548a315509cc478473ca344ac9e2975521230e9654b78bc35db4e489dc47ed2c711d
-  data.tar.gz: c18707a6fc4f48be132091376dc6ec39322868aabd1fdcb5201ae53421947abfff3bcbc790cc6068345fe979f3cfb9b47db6fe3a3263fb0c7f7e225033ed9a9f
+  metadata.gz: b47c5ea02935ff7082779b07dfe2275af3e8d5851b63772364665d5425380ea7e6cd6b98adfe1bc7502af1f0e924b343f56d3a2e303afdfdc2118f133ec8c043
+  data.tar.gz: ee6f09275d11db038970e79661669e06013011a9100fbd449cd59e1a7f8a33818502074e7c564b14cbbf3cc10f660fac8827b0a6fb90d4e20fcc6cdd62eec2ae

data/README.md

@@ -1,8 +1,6 @@
 # NovaposhtaApi
 
-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/novaposhta_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple Novaposhta API 2.0 Ruby client. API documentation by link https://devcenter.novaposhta.ua/docs/services/
 
 ## Installation
 
@@ -20,19 +18,47 @@ Or install it yourself as:
 
     $ gem install novaposhta_api
 
+## Setup
+
+```
+NovaposhtaApi.setup do |config|
+  config.api_url = 'https://api.novaposhta.ua/v2.0/json/'
+  config.api_key = 'KEY'
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Define API client:
+```
+client = NovaposhtaApi::Client.new
+```
 
-## Development
+Cities:
+```
+client.cities.all
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Settlements:
+```
+client.settlements.all
+```
+
+Warehouses:
+```
+client.warehouses.all
+```
+
+Create internet document:
+```
+client.internet_documents.create(params)
+```
 
-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).
+TODO
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/novaposhta_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/novaposhta_api/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/venethub/novaposhta_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/venethub/novaposhta_api/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +67,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the NovaposhtaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/novaposhta_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the NovaposhtaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/venethub/novaposhta_api/blob/master/CODE_OF_CONDUCT.md).

data/lib/novaposhta_api/client.rb

@@ -6,6 +6,8 @@ module NovaposhtaApi
 
     def initialize(api_key: nil)
       @api_key = api_key
+
+      yield(http.connection) if block_given?
     end
 
     def self.resources
@@ -21,7 +23,7 @@ module NovaposhtaApi
 
     def method_missing(name, *args, &block)
       if with_resource?(name)
-        resources[name] ||= self.class.resources[name].new(connection: connection)
+        resources[name] ||= self.class.resources[name].new(http: http)
         resources[name]
       else
         super
@@ -40,8 +42,8 @@ module NovaposhtaApi
       @resources ||= {}
     end
 
-    def connection
-      @connection ||= NovaposhtaApi::HttpClient.new(
+    def http
+      @http ||= NovaposhtaApi::HttpClient.new(
         uri: NovaposhtaApi.configuration.api_url,
         api_key: api_key || NovaposhtaApi.configuration.api_key
       )

data/lib/novaposhta_api/http_client.rb

@@ -11,6 +11,8 @@ module NovaposhtaApi
 
     def initialize(config)
       @config = config.with_indifferent_access
+
+      yield(connection) if block_given?
     end
 
     def uri
@@ -27,20 +29,16 @@ module NovaposhtaApi
       response.body
     end
 
-    private
-
-    def transform_keys(params)
-      convert_params_to_hash(params).deep_transform_keys { |key| key.to_s.camelcase }
-    end
-
-    def convert_params_to_hash(params)
-      if params.respond_to?(:to_unsafe_h)
-        params.to_unsafe_h
-      else
-        params
+    def connection
+      @connection ||= Faraday.new(connection_options) do |client|
+        client.adapter Faraday.default_adapter
+        client.response :error_handling
+        client.response :json
       end
     end
 
+    private
+
     def build_options(path)
       paths = path.split('/')
 
@@ -51,19 +49,23 @@ module NovaposhtaApi
       }
     end
 
-    def connection
-      @connection ||= Faraday.new(connection_options) do |client|
-        client.adapter Faraday.default_adapter
-        client.response :error_handling
-        client.response :json
-      end
-    end
-
     def connection_options
       {
         url: uri,
         headers: DEFAULT_HEADERS
       }
     end
+
+    def transform_keys(params)
+      convert_params_to_hash(params).deep_transform_keys { |key| key.to_s.camelcase }
+    end
+
+    def convert_params_to_hash(params)
+      if params.respond_to?(:to_unsafe_h)
+        params.to_unsafe_h
+      else
+        params
+      end
+    end
   end
 end

data/lib/novaposhta_api/middlewares/error_handling.rb

@@ -2,7 +2,7 @@
 
 module NovaposhtaApi
   module Middlewares
-    class ErrorHandling < Faraday::Response::Middleware
+    class ErrorHandling < Faraday::Middleware
       SEPARATOR = ', '
 
       def on_complete(env)

data/lib/novaposhta_api/models/city.rb

@@ -7,6 +7,9 @@ module NovaposhtaApi
       property :city_id, from: :CityID
       property :area, from: :Area
       property :description, from: :Description
+      property :description_ru, from: :DescriptionRu
+      property :settlement_type_description, from: :SettlementTypeDescription
+      property :settlement_type_description_ru, from: :SettlementTypeDescriptionRu
     end
   end
 end

data/lib/novaposhta_api/models/contact_person.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NovaposhtaApi
+  module Models
+    class ContactPerson < Model
+      property :ref, from: :Ref
+      property :first_name, from: :FirstName
+      property :middle_name, from: :MiddleName
+      property :last_name, from: :LastName
+      property :phones, from: :Phones
+      property :description, from: :Description
+      property :email, from: :Email
+    end
+  end
+end

data/lib/novaposhta_api/models/warehouse.rb

@@ -6,7 +6,9 @@ module NovaposhtaApi
       property :ref, from: :Ref
       property :city_ref, from: :CityRef
       property :city_description, from: :CityDescription
+      property :city_description_ru, from: :CityDescriptionRu
       property :description, from: :Description
+      property :description_ru, from: :DescriptionRu
       property :short_address, from: :ShortAddress
       property :longitude, from: :Longitude
       property :latitude, from: :Latitude

data/lib/novaposhta_api/resource.rb

@@ -2,18 +2,17 @@
 
 module NovaposhtaApi
   class Resource
-    attr_reader :connection
+    attr_reader :http
 
     HTTP_METHODS = %i[get post patch put delete].freeze
-    CACHE_OPTIONS = {expires_in: 1.day}.freeze
 
-    def initialize(connection: nil)
-      @connection = connection
+    def initialize(http: nil)
+      @http = http
     end
 
     HTTP_METHODS.each do |http_method|
       define_method http_method do |*args|
-        response = connection.request(http_method, *args)
+        response = http.request(http_method, *args)
         response['data']
       end
     end

data/lib/novaposhta_api/resources/city_resource.rb

@@ -4,9 +4,7 @@ module NovaposhtaApi
   module Resources
     class CityResource < Resource
       def all(params = {})
-        response = Rails.cache.fetch("cities/#{params}", CACHE_OPTIONS) do
-          post('Address/getCities', params)
-        end
+        response = post('Address/getCities', params)
 
         NovaposhtaApi::Models::City.extract_collection(response)
       end

data/lib/novaposhta_api/resources/settlement_resource.rb

@@ -4,9 +4,7 @@ module NovaposhtaApi
   module Resources
     class SettlementResource < Resource
       def all(params = {})
-        response = Rails.cache.fetch("settlements/#{params}", CACHE_OPTIONS) do
-          post('Address/searchSettlements', params)
-        end
+        response = post('Address/searchSettlements', params)
 
         NovaposhtaApi::Models::Settlement.extract_collection(response[0]['Addresses'])
       end

data/lib/novaposhta_api/resources/warehouse_resource.rb

@@ -4,9 +4,7 @@ module NovaposhtaApi
   module Resources
     class WarehouseResource < Resource
       def all(params = {})
-        response = Rails.cache.fetch("warehouses/#{params}", CACHE_OPTIONS) do
-          post('Address/getWarehouses', params)
-        end
+        response = post('Address/getWarehouses', params)
 
         NovaposhtaApi::Models::Warehouse.extract_collection(response)
       end

data/lib/novaposhta_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NovaposhtaApi
-  VERSION = '0.1.3'
+  VERSION = '0.1.7'
 end

data/lib/novaposhta_api.rb

@@ -12,7 +12,6 @@ module NovaposhtaApi
 
   module Middlewares
     autoload :ErrorHandling, 'novaposhta_api/middlewares/error_handling'
-    autoload :ParseJson, 'novaposhta_api/middlewares/parse_json'
   end
 
   module Resources
@@ -31,6 +30,7 @@ module NovaposhtaApi
     autoload :TrackingDocument, 'novaposhta_api/models/tracking_document'
     autoload :Settlement, 'novaposhta_api/models/settlement'
     autoload :Warehouse, 'novaposhta_api/models/warehouse'
+    autoload :ContactPerson, 'novaposhta_api/models/contact_person'
   end
 
   Error = Class.new(StandardError)
@@ -51,7 +51,7 @@ module NovaposhtaApi
 
   # @example
   #   NovaposhtaApi.setup do |config|
-  #     config.api_url = "https://api.novaposhta.ua/v2.0/json/"
+  #     config.api_url = 'https://api.novaposhta.ua/v2.0/json/'
   #   end
   #
   def self.setup
@@ -59,7 +59,6 @@ module NovaposhtaApi
   end
 
   if Faraday::Middleware.respond_to? :register_middleware
-    Faraday::Response.register_middleware json: NovaposhtaApi::Middlewares::ParseJson
     Faraday::Response.register_middleware error_handling: NovaposhtaApi::Middlewares::ErrorHandling
   end
 end

data/novaposhta_api.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  spec.add_dependency 'faraday', '~> 2.2'
   spec.add_dependency 'hashie', '~> 4.1'
 
-  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: novaposhta_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.7
 platform: ruby
 authors:
 - venet
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: '1.25'
 description: Ruby wrapper for NovaPoshta API 2.0.
 email:
 - venet.dev@gmail.com
@@ -84,9 +78,9 @@ files:
 - lib/novaposhta_api/configuration.rb
 - lib/novaposhta_api/http_client.rb
 - lib/novaposhta_api/middlewares/error_handling.rb
-- lib/novaposhta_api/middlewares/parse_json.rb
 - lib/novaposhta_api/model.rb
 - lib/novaposhta_api/models/city.rb
+- lib/novaposhta_api/models/contact_person.rb
 - lib/novaposhta_api/models/counterparty.rb
 - lib/novaposhta_api/models/internet_document.rb
 - lib/novaposhta_api/models/settlement.rb
@@ -107,7 +101,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/venethub/novaposhta_api
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Novaposhta API 2.0 client
 test_files: []

data/lib/novaposhta_api/middlewares/parse_json.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module NovaposhtaApi
-  module Middlewares
-    class ParseJson < Faraday::Response::Middleware
-      def on_complete(env)
-        process_response(env)
-      end
-
-      def process_response(env)
-        env[:body] = JSON.parse(env[:body])
-      rescue Faraday::ParsingError => e
-        raise Faraday::ParsingError.new(e.wrapped_exception, env[:response])
-      end
-    end
-  end
-end