novaposhta_api 0.1.0 → 0.1.5

data/lib/novaposhta_api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'novaposhta_api/version'
+require 'novaposhta_api/configuration'
 
 module NovaposhtaApi
   autoload :Client, 'novaposhta_api/client'
@@ -18,6 +19,7 @@ module NovaposhtaApi
     autoload :CityResource, 'novaposhta_api/resources/city_resource'
     autoload :CounterpartyResource, 'novaposhta_api/resources/counterparty_resource'
     autoload :InternetDocumentResource, 'novaposhta_api/resources/internet_document_resource'
+    autoload :TrackingDocumentResource, 'novaposhta_api/resources/tracking_document_resource'
     autoload :SettlementResource, 'novaposhta_api/resources/settlement_resource'
     autoload :WarehouseResource, 'novaposhta_api/resources/warehouse_resource'
   end
@@ -26,16 +28,41 @@ module NovaposhtaApi
     autoload :City, 'novaposhta_api/models/city'
     autoload :Counterparty, 'novaposhta_api/models/counterparty'
     autoload :InternetDocument, 'novaposhta_api/models/internet_document'
+    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)
   ResourceError = Class.new(Error)
   ResponseError = Class.new(Error)
 
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  # @example
+  #   NovaposhtaApi.setup do |config|
+  #     config.api_url = 'https://api.novaposhta.ua/v2.0/json/'
+  #   end
+  #
+  def self.setup
+    yield configuration
+  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
+
+require 'novaposhta_api/rails'

data/lib/novaposhta_api/client.rb

@@ -2,11 +2,12 @@
 
 module NovaposhtaApi
   class Client
-    attr_reader :api_url, :api_key
+    attr_reader :api_key
 
-    def initialize(api_url: nil, api_key:)
-      @api_url = api_url || ENV['NOVAPOSHTA_URL']
-      @api_key = api_key || delivery_member_api_key || ENV['NOVAPOSHTA_KEY']
+    def initialize(api_key: nil)
+      @api_key = api_key
+
+      yield(http.connection) if block_given?
     end
 
     def self.resources
@@ -14,14 +15,15 @@ module NovaposhtaApi
         cities: Resources::CityResource,
         counterparties: Resources::CounterpartyResource,
         internet_documents: Resources::InternetDocumentResource,
+        tracking_documents: Resources::TrackingDocumentResource,
         settlements: Resources::SettlementResource,
         warehouses: Resources::WarehouseResource
       }
     end
 
     def method_missing(name, *args, &block)
-      if self.class.resources.keys.include?(name)
-        resources[name] ||= self.class.resources[name].new(connection: connection)
+      if with_resource?(name)
+        resources[name] ||= self.class.resources[name].new(http: http)
         resources[name]
       else
         super
@@ -29,22 +31,22 @@ module NovaposhtaApi
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      self.class.resources.keys.include?(method_name) || super
+      with_resource?(method_name) || super
+    end
+
+    def with_resource?(resource_name)
+      self.class.resources.keys.include?(resource_name)
     end
 
     def resources
       @resources ||= {}
     end
 
-    def connection
-      @connection ||= NovaposhtaApi::HttpClient.new(
-        uri: api_url,
-        api_key: api_key
+    def http
+      @http ||= NovaposhtaApi::HttpClient.new(
+        uri: NovaposhtaApi.configuration.api_url,
+        api_key: api_key || NovaposhtaApi.configuration.api_key
       )
     end
-
-    def delivery_member_api_key
-      @delivery_member_api_key ||= Delivery::Member.select(:api_key).primary&.api_key
-    end
   end
 end

data/lib/novaposhta_api/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module NovaposhtaApi
+  class Configuration
+    attr_accessor :api_url, :api_key
+
+    def initialize
+      @api_url = 'https://api.novaposhta.ua/v2.0/json/'
+      @api_key = ''
+    end
+  end
+end

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
@@ -22,26 +24,21 @@ module NovaposhtaApi
     end
 
     def request(http_method, path, params = {})
-      options = build_options(path).merge!(methodProperties: transform_keys(params))
-
+      options = build_options(path).merge(methodProperties: transform_keys(params))
       response = connection.public_send(http_method, '', options.to_json)
       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('/')
 
@@ -52,20 +49,23 @@ module NovaposhtaApi
       }
     end
 
-    def connection
-      @connection ||= Faraday.new(connection_options) do |client|
-        client.adapter Faraday.default_adapter
-        client.use NovaposhtaApi::Middlewares::ErrorHandling
-        client.response :json
-        client.response :logger if Rails.env.development?
-      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

@@ -12,13 +12,13 @@ module NovaposhtaApi
       end
 
       def error_message(body)
-        (from_codes(body['errorCodes']) || body['errors']).join(SEPARATOR)
+        (from_codes(body['errorCodes']) || body['errors'] || body['message']).join(SEPARATOR)
       end
 
       def from_codes(codes = [])
         return nil if codes.blank?
 
-        codes.map { |code| I18n.t(code, scope: %i[NovaposhtaApi errors]) }
+        codes.map { |code| I18n.t(code, scope: %i[novaposhta errors]) }
       end
     end
   end

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/tracking_document.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module NovaposhtaApi
+  module Models
+    class TrackingDocument < Model
+      property :number, from: :Number
+      property :status, from: :Status
+      property :status_code, from: :StatusCode
+      property :scheduled_delivery_date, from: :ScheduledDeliveryDate
+    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/rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NovaposhtaApi
+  class Engine < ::Rails::Engine
+  end
+end

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/tracking_document_resource.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NovaposhtaApi
+  module Resources
+    class TrackingDocumentResource < Resource
+      def track(number)
+        response = post(
+          'TrackingDocument/getStatusDocuments', documents: [{document_number: number}]
+        )
+
+        NovaposhtaApi::Models::TrackingDocument.extract_single(response)
+      end
+    end
+  end
+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.0'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: novaposhta_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - venet
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,23 +75,31 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/locales/novaposhta.en.yml
+- config/locales/novaposhta.ru.yml
+- config/locales/novaposhta.uk.yml
 - lib/novaposhta_api.rb
 - lib/novaposhta_api/client.rb
 - lib/novaposhta_api/collection.rb
+- 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
+- lib/novaposhta_api/models/tracking_document.rb
 - lib/novaposhta_api/models/warehouse.rb
+- lib/novaposhta_api/rails.rb
 - lib/novaposhta_api/resource.rb
 - lib/novaposhta_api/resources/city_resource.rb
 - lib/novaposhta_api/resources/counterparty_resource.rb
 - lib/novaposhta_api/resources/internet_document_resource.rb
 - lib/novaposhta_api/resources/settlement_resource.rb
+- lib/novaposhta_api/resources/tracking_document_resource.rb
 - lib/novaposhta_api/resources/warehouse_resource.rb
 - lib/novaposhta_api/version.rb
 - novaposhta_api.gemspec
@@ -100,7 +108,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/venethub/novaposhta_api
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,9 +123,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.0.9
+signing_key:
 specification_version: 4
 summary: Novaposhta API 2.0 client
 test_files: []