nova_poshta 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baf0a2127bb62c5a4479b4b3f73917aca8607eb3
+  data.tar.gz: f74ec24bbb02caa93c0fbda878449506a0bac600
+SHA512:
+  metadata.gz: db600f9067af16c9f3f1fb78119639fc187352937db4843f5d5265c6a451f0774ad0735a57441da8d483c588ab0454b6955e201deef3433e6a74678197f171a9
+  data.tar.gz: b8b30f998e7e54c83a08b184a875724f9b7df5c80ae7f823dccf9a90cbe9b43ed86bde55d3eb68c3ab52ab3ecb1b165d509758ce03f5af585eec2e42f3415898

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gigorok@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nova_poshta.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Igor Gonchar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# NovaPoshta
+
+[![Build Status](https://travis-ci.org/gigorok/nova_poshta.svg?branch=master)](https://travis-ci.org/gigorok/nova_poshta)
+
+Ruby-client to novaposhta.ua API2.
+
+Look at API documentation by link https://my.novaposhta.ua/data/instruction_JSON_ver.1.7.pdf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nova_poshta'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nova_poshta
+
+## Configuration
+
+By default the application gets API KEY from ENV['NOVA_POSHTA_API_KEY'].
+But you can set it directly by next code:
+```ruby
+NovaPoshta.configure do |config|
+    config.api_key = 'YOUR_API_KEY'
+end
+```
+
+## Usage
+```ruby
+a = NovaPoshta::Model::Address.new # an instance of address model
+area = a.areas.to_a.sample # to get a some area
+area.cities # to get all cities
+city = a.cities(find_by_string: '[city name]').to_a.sample # you can filter by city name
+city.area # get the area from a city instance
+warehouse = city.warehouses(find_by_string: '[warehouse address]').to_a.sample
+a.warehouses(city.ref)
+a.areas
+```
+
+## 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/gigorok/nova_poshta. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nova_poshta"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nova_poshta/api.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module NovaPoshta
+  class Api
+    API_URL = 'https://api.novaposhta.ua/v2.0/json/'.freeze
+
+    attr_accessor :api_key, :model_name
+
+    def initialize(model_name)
+      self.api_key = NovaPoshta.configuration.api_key
+      self.model_name = model_name
+    end
+
+    def request(called_method, method_properties={})
+      response = post(request_body(called_method, method_properties))
+      ::NovaPoshta::Result.new(response, called_method, self)
+    end
+
+    def request_body(called_method, method_props={})
+      camelize_keys(
+          {
+              api_key: api_key,
+              model_name: model_name,
+              called_method: called_method,
+              method_properties: method_properties(method_props)
+          }, :lower
+      ).to_json
+    end
+
+    protected
+
+    def method_properties(method_props)
+      camelize_keys(method_props, :upper)
+    end
+
+    def post(req_body)
+      uri = URI.parse(API_URL)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true if uri.scheme == 'https'
+      req = Net::HTTP::Post.new(uri.path)
+      req.body = req_body
+      https.request(req).body
+    end
+
+    def camelize_keys(h, first_letter = :upper)
+      h.keys.each do |k|
+        new_key = k.to_s.camelize(first_letter)
+        new_key = new_key.to_sym if k.is_a? Symbol
+        h[new_key] = h.delete(k)
+      end
+      h
+    end
+
+  end
+end

data/lib/nova_poshta/configuration.rb

@@ -0,0 +1,14 @@
+module NovaPoshta
+  class Configuration
+    attr_writer :api_key
+
+    def initialize
+      @api_key = ENV['NOVA_POSHTA_API_KEY']
+    end
+
+    def api_key
+      @api_key || (raise UndefinedApiKeyError.new)
+    end
+
+  end
+end

data/lib/nova_poshta/error.rb

@@ -0,0 +1,9 @@
+module NovaPoshta
+  class Error < StandardError
+
+  end
+
+  class UndefinedApiKeyError < Error
+
+  end
+end

data/lib/nova_poshta/model/address.rb

@@ -0,0 +1,20 @@
+module NovaPoshta
+  module Model
+    class Address < ::NovaPoshta::Model::Base
+
+      # you can use params as {find_by_string: 'Одесса'} to filter by city_name
+      def cities(params={})
+        api.request('getCities', params)
+      end
+
+      def warehouses(city_ref, params={})
+        api.request('getWarehouses', {city_ref: city_ref}.merge(params))
+      end
+
+      def areas(params={})
+        api.request('getAreas', params)
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/model/base.rb

@@ -0,0 +1,13 @@
+module NovaPoshta
+  module Model
+    class Base
+
+      attr_accessor :api
+
+      def api
+        @api ||= Api.new(self.class.name.split('::').last)
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/response/area.rb

@@ -0,0 +1,14 @@
+module NovaPoshta
+  module Response
+    class Area < ::NovaPoshta::Response::Base
+
+      attr_accessor :description, :ref, :areas_center
+
+      # ugly API do not provide searching by area reference
+      def cities(params={})
+        @api.request('getCities', params).select { |city| city.area_ref == self.ref }
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/response/base.rb

@@ -0,0 +1,19 @@
+module NovaPoshta
+  module Response
+    class Base
+
+      attr_accessor :api, :result
+
+      def initialize(attrs)
+        attrs.each do |k, v|
+          if self.respond_to?("#{k.to_s.underscore}=".to_sym) # map only defined
+            self.public_send("#{k.to_s.underscore}=".to_sym, v)
+          end
+        end
+
+        yield self if block_given?
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/response/city.rb

@@ -0,0 +1,23 @@
+module NovaPoshta
+  module Response
+    class City < ::NovaPoshta::Response::Base
+
+      attr_accessor :description, :description_ru, :ref, :delivery1, :delivery2, :delivery3, :delivery4,
+                    :delivery5, :delivery6, :delivery7, :area_ref, :conglomerates, :city_id
+
+      def warehouses(params={})
+        @api.request('getWarehouses', {city_ref: self.ref}.merge(params))
+      end
+
+      def area(params={})
+        @api.request('getAreas', params).select { |area| area.ref == self.area_ref }.first.result
+      end
+
+      # city has area attribute, but it should be area_ref, so next writer will fix this situation
+      def area=(area_ref)
+        self.area_ref = area_ref
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/response/warehouse.rb

@@ -0,0 +1,17 @@
+module NovaPoshta
+  module Response
+    class Warehouse < ::NovaPoshta::Response::Base
+
+      attr_accessor :description, :description_ru, :phone, :type_of_warehouse, :ref, :number, :city_ref,
+                    :max_weight_allowed, :longitude, :latitude, :reception, :delivery, :schedule,
+                    :site_key, :city_description, :city_description_ru, :post_finance, :pos_terminal,
+                    :total_max_weight_allowed, :place_max_weight_allowed
+
+      # ugly API do not provide searching by city reference
+      def city(params={})
+        @api.request('getCities', params).select { |city| city.ref == self.city_ref }.first.result
+      end
+
+    end
+  end
+end

data/lib/nova_poshta/result.rb

@@ -0,0 +1,54 @@
+module NovaPoshta
+  class Result
+
+    include Enumerable
+
+    attr_accessor :success, :data, :errors, :warnings, :info
+    attr_reader :body, :raw_body
+
+    def initialize(raw_body, called_method, api)
+      @raw_body = raw_body
+      @body = JSON.parse(raw_body)
+      @called_method = called_method
+      @api = api
+    end
+
+    def success?
+      body['success']
+    end
+
+    def data
+      body['data'].map do |attrs|
+        response_class.new(attrs) do |r|
+          r.api = @api
+          r.result = self
+        end
+      end if body['data']
+    end
+
+    def errors
+      body['errors']
+    end
+
+    def warnings
+      body['warnings']
+    end
+
+    def info
+      body['info']
+    end
+
+    def each(&block)
+      data.each do |member|
+        block.call(member)
+      end
+    end
+
+    protected
+
+    def response_class
+      "::NovaPoshta::Response::#{@called_method[3..-1].singularize}".safe_constantize
+    end
+
+  end
+end

data/lib/nova_poshta/version.rb

@@ -0,0 +1,3 @@
+module NovaPoshta
+  VERSION = "0.2.0"
+end

data/lib/nova_poshta.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+
+# require base classes because the order in this situation makes sense
+require "nova_poshta/response/base"
+require "nova_poshta/model/base"
+
+Dir[File.dirname(__FILE__) + '/nova_poshta/*.rb'].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/nova_poshta/response/*.rb'].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/nova_poshta/model/*.rb'].each { |f| require f }
+
+module NovaPoshta
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+end

data/nova_poshta.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nova_poshta/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "nova_poshta"
+  spec.version = NovaPoshta::VERSION
+  spec.authors = ["Igor Gonchar"]
+  spec.email = ["igor.gonchar@gmail.com"]
+
+  spec.summary = %q{Ruby-client to novaposhta.ua API.}
+  spec.homepage = "https://github.com/gigorok/nova_poshta"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: nova_poshta
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Igor Gonchar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: 
+email:
+- igor.gonchar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nova_poshta.rb
+- lib/nova_poshta/api.rb
+- lib/nova_poshta/configuration.rb
+- lib/nova_poshta/error.rb
+- lib/nova_poshta/model/address.rb
+- lib/nova_poshta/model/base.rb
+- lib/nova_poshta/response/area.rb
+- lib/nova_poshta/response/base.rb
+- lib/nova_poshta/response/city.rb
+- lib/nova_poshta/response/warehouse.rb
+- lib/nova_poshta/result.rb
+- lib/nova_poshta/version.rb
+- nova_poshta.gemspec
+homepage: https://github.com/gigorok/nova_poshta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Ruby-client to novaposhta.ua API.
+test_files: []