postmen 0.1.0 → 1.0.0.pre.alpha.1

data/lib/postmen.rb

@@ -9,29 +9,64 @@ require 'postmen/version'
 require 'postmen/types'
 require 'postmen/connection'
 require 'postmen/collection_proxy'
+require 'postmen/parcel'
+require 'postmen/shipment'
 require 'postmen/label'
 require 'postmen/label_collection'
 require 'postmen/response'
 require 'postmen/query/label_query'
 require 'postmen/query/create_label_query'
-
+require 'postmen/query/rate_query'
+require 'postmen/query/create_rate_query'
+require 'postmen/rate_object'
+require 'postmen/rate'
+require 'postmen/rate_collection'
+require 'postmen/shipper_account'
+require 'postmen/shipper_account_collection'
+require 'postmen/query/shipper_account_query'
+require 'postmen/query/create_shipper_account_query'
+require 'postmen/query/shipper_account_query'
+require 'postmen/query/shipper_account_update_query'
+require 'postmen/query/shipper_account_update_credentials_query'
+require 'postmen/query/manifest_query'
+require 'postmen/query/create_manifest_query'
+require 'postmen/manifest'
+require 'postmen/manifest_collection'
+# This is the main class, it's being used as a namespace for all
+# related classes and modules as well.
 class Postmen
   extend Dry::Configurable
 
+  # Generic Exception class, all other exceptions should inherit from this class
   Error = Class.new(StandardError)
+  # Exception raised if rate limit was exceeded
   RateLimitExceeded = Class.new(Error)
+  # Exception raised in case of any connection error
   ConnectionError = Class.new(Error)
+  # Generic exception raised if the API returns an error
   RequestError = Class.new(Error)
+  # Expcetion raised if resource was not found.
   ResourceNotFound = Class.new(RequestError)
 
+  # @#!attribute [rw] api_key [String] API key taken from the application.
   setting :api_key
+
+  # @#!attribute [rw] region [String] Region - typically either 'sandbox' or 'production'
   setting :region
+
+  # @#!attribute endpoint [String] Endoint name - specify if you'd like to use custom endpoint
   setting :endpoint
 
+  # Returns the endpoint used in all queries
+  #
+  # @return [String] endpoint url
   def self.endpoint
     config.endpoint || "https://#{config.region}-api.postmen.com/v3"
   end
 
+  # Returns path where gem is installed
+  #
+  # @return [Pathname] path
   def self.root
     Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '../')))
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: postmen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.pre.alpha.1
 platform: ruby
 authors:
 - postmen.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Developed for easy integration with Postmen
 email:
 - support@postmen.com
@@ -135,10 +163,44 @@ files:
 - lib/postmen/connection.rb
 - lib/postmen/label.rb
 - lib/postmen/label_collection.rb
+- lib/postmen/manifest.rb
+- lib/postmen/manifest_collection.rb
+- lib/postmen/parcel.rb
 - lib/postmen/query/create_label_query.rb
+- lib/postmen/query/create_manifest_query.rb
+- lib/postmen/query/create_rate_query.rb
+- lib/postmen/query/create_shipper_account_query.rb
 - lib/postmen/query/label_query.rb
+- lib/postmen/query/manifest_query.rb
+- lib/postmen/query/rate_query.rb
+- lib/postmen/query/shipper_account_query.rb
+- lib/postmen/query/shipper_account_update_credentials_query.rb
+- lib/postmen/query/shipper_account_update_query.rb
+- lib/postmen/rate.rb
+- lib/postmen/rate_collection.rb
+- lib/postmen/rate_object.rb
 - lib/postmen/response.rb
+- lib/postmen/shipment.rb
+- lib/postmen/shipper_account.rb
+- lib/postmen/shipper_account_collection.rb
 - lib/postmen/types.rb
+- lib/postmen/types/address.rb
+- lib/postmen/types/aes.rb
+- lib/postmen/types/billing.rb
+- lib/postmen/types/brief_shipper_account.rb
+- lib/postmen/types/customs.rb
+- lib/postmen/types/customs_billing.rb
+- lib/postmen/types/detailed_charges.rb
+- lib/postmen/types/dimension.rb
+- lib/postmen/types/invoice.rb
+- lib/postmen/types/item.rb
+- lib/postmen/types/money.rb
+- lib/postmen/types/no_eei.rb
+- lib/postmen/types/passport.rb
+- lib/postmen/types/payment_method.rb
+- lib/postmen/types/reference.rb
+- lib/postmen/types/uuid.rb
+- lib/postmen/types/weight.rb
 - lib/postmen/version.rb
 homepage: https://www.postmen.com
 licenses:
@@ -155,12 +217,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Postmen