novaposhta2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38cb5589cccece09ff4c03ff6afad4d2af543183
-  data.tar.gz: 56e5ff8e69fde1c4eb47a9b5384c00b36b81d9d3
+  metadata.gz: e13968415cc81354bf69c306d9484608256340e2
+  data.tar.gz: 62e993aa3d81cea2fbf646c62e7f0e8e0c29492e
 SHA512:
-  metadata.gz: b6122f742275a38752e198602fadf1f48b8aac7a4723d5a9413bab77ad6b19ffecb064db444592f5d9f838d9f9fa7561a8a1144b7e47ec34a55752ed1a2d3988
-  data.tar.gz: 3a15684d92859fa4609f89163387ecb70fc79a521228890d662c46a6091e53da17e8bb0a8b5dbbf807f0d5802b8cdaa06537e0bfb1d4d1cc617c25ab92d5169c
+  metadata.gz: eee5c85f5011ba2f45f0be48befe7ed1224a8706e8671a2eec35e8bca67fbf605964066d1a4e2a4b656085b85627227fa27f248b2378c6744977ce0a74f509e2
+  data.tar.gz: 0a5fa114f68ffabceb81bf67473b21cb53bac3d005cde75280a8a54be57dc0e99e61486b7bb9237792326c322022decb3a0eee45aee3abc6131acfd8b865d7c8

data/lib/novaposhta2.rb

@@ -9,19 +9,38 @@ require 'novaposhta2/city'
 require 'novaposhta2/warehouse'
 require 'novaposhta2/package'
 
+# Novaposhta API 2.0 Gem.
+# == Configuration
+#
+#   Novaposhta2.configure do |config|
+#     config.api_key = 'Your api key'
+#     config.sender = {
+#       ref: 'Sender reference',
+#       city: 'City reference',
+#       address: 'Sender warehouse reference',
+#       contact: 'Sender contact reference',
+#       phone: 'Sender phone',
+#     }
+#   end
+#
+
 module Novaposhta2
-  def self.configuration
+
+  def self.configuration # :nodoc:
     @configuration ||= Configuration.new
   end
 
-  def self.configure
+  def self.configure # :nodoc:
     yield configuration
   end
 
-  def self.[](index)
-    City[index]
+  # Returns a city found by name or part of the name.
+  # If more than one city match +name+ - returns nil.
+  def self.[](name)
+    City[name]
   end
 
+  # Returns shipment tracking information by tracking number.
   def self.track(tracking)
     Package.track(tracking)
   end

data/lib/novaposhta2/base.rb

@@ -1,7 +1,9 @@
 module Novaposhta2
-  class Base
+  class Base # :nodoc:
     include Post
 
+    private
+
     def config
       Novaposhta2.configuration
     end

data/lib/novaposhta2/city.rb

@@ -1,6 +1,7 @@
 module Novaposhta2
+  # Represents a known city.
   class City < Base
-    attr_reader :description, :description_ru, :ref
+    attr_reader :description, :description_ru, :ref # :nodoc:
 
     def initialize(params)
       @description = params['Description']
@@ -8,6 +9,7 @@ module Novaposhta2
       @ref = params['Ref']
     end
 
+    # Lists all warehouses or returns warehouse by number.
     def warehouses(number = nil)
       @warehouses ||= post('Address', 'getWarehouses', CityRef: @ref)['data'].map do |data|
         Warehouse.new(data)
@@ -22,20 +24,25 @@ module Novaposhta2
 
     alias [] warehouses
 
+    # Creates new person that belongs to the city.
     def person(firstname, lastname, phone)
       Person.new(self, firstname, lastname, phone)
     end
 
     class << self
 
+      # Returns city matching +ref+.
       def find_by_ref(ref)
         query(Ref: ref).first
       end
 
+      # Returns all cities matching a pattern.
       def match(name)
         query(FindByString: name)
       end
 
+      # Returns a city by name or part of the name.
+      # If more than one city match a +name+ - returns nil.
       def find(name)
         m = match(name)
         m.count == 1 ? m[0] : nil
@@ -43,6 +50,7 @@ module Novaposhta2
 
       alias [] find
 
+      # Returns list of all known cities.
       def all
         match(nil)
       end

data/lib/novaposhta2/configuration.rb

@@ -1,5 +1,5 @@
 module Novaposhta2
-  class Configuration
+  class Configuration # :nodoc:
     attr_accessor :api_key, :sender
     def initialize
       @api_key = ENV['NOVAPOSHTA_API_KEY']

data/lib/novaposhta2/package.rb

@@ -1,17 +1,31 @@
 module Novaposhta2
+
+  # Represents a package.
+  # == Options
+  # [cost] *Mandatory*. Cost of the package contents, for insurance needs.
+  # [description] *Mandatory*. Description of package contents.
+  # [internal_number] Internal order number.
+  # [payer_type] *Sender* of *Recipient*. Default: *Sender*.
+  # [payment_method] *Cash* or *NonCash*. Default: *Cash*.
+  # [seats] Number of boxes. Default: *1*.
+  # [volume] *Mandatory*. Volume of the package in *cm*
+  # [weight] *Mandatory*. Weight of the package in *kg*.
+
   class Package < Base
-    attr_accessor :address, :recipient, :options, :ref, :tracking
+    attr_accessor :address, :recipient, :options, :ref, :tracking # :nodoc:
 
-    def initialize(address, recipient, options = {})
+    def initialize(address, recipient, options = {}) # :nodoc:
       @address = address
       @recipient = recipient
       @options = options
     end
 
+    # Get the shipping rate.
     def rate
       post('InternetDocument', 'getDocumentPrice', params)['data'][0]['Cost'].to_i
     end
 
+    # Commit the package.
     def save
       data = post('InternetDocument', 'save', params)
 
@@ -19,14 +33,17 @@ module Novaposhta2
       @tracking = data['data'][0]['IntDocNumber']
     end
 
+    # Print package markings.
     def print
       "https://my.novaposhta.ua/orders/printMarkings/orders/#{@ref}/type/html/apiKey/#{config.api_key}"
     end
 
+    # Get package tracking information.
     def track
       self.class.track(@tracking)
     end
 
+    # Get tracking information by tracking number.
     def self.track(tracking)
       post('InternetDocument', 'documentsTracking', Documents: [tracking.to_s])['data'][0]
     end

data/lib/novaposhta2/person.rb

@@ -1,8 +1,9 @@
 module Novaposhta2
+  # Represents a package recipient.
   class Person < Base
-    attr_reader :city, :firstname, :lastname, :phone, :ref, :contact_ref
+    attr_reader :city, :firstname, :lastname, :phone, :ref, :contact_ref # :nodoc:
 
-    def initialize(city, firstname, lastname, phone)
+    def initialize(city, firstname, lastname, phone) #:nodoc:
       @city, @firstname, @lastname, @phone = city, firstname, lastname, phone
 
       data = post('Counterparty', 'save',
@@ -19,6 +20,7 @@ module Novaposhta2
       @contact_ref = data['ContactPerson']['data'][0]['Ref']
     end
 
+    # Creates a new package for the person.
     def package(address, options)
       Package.new(address, self, options)
     end

data/lib/novaposhta2/post.rb

@@ -1,5 +1,5 @@
 module Novaposhta2
-  module Post
+  module Post # :nodoc:
     def self.included(base)
       base.extend(self)
     end

data/lib/novaposhta2/warehouse.rb

@@ -1,8 +1,9 @@
 module Novaposhta2
+  # Represents a warehouse.
   class Warehouse < Base
-    attr_reader :description, :description_ru, :ref, :number, :longtitude, :latitude
+    attr_reader :description, :description_ru, :ref, :number, :longtitude, :latitude #:nodoc:
 
-    def initialize(params)
+    def initialize(params) #:nodoc:
       @description = params['Description']
       @description_ru = params['DescriptionRu']
       @ref = params['Ref']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: novaposhta2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Oleg Kukareka