postnord 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 625ad1e48069d8cbc99a4b6c526e0a48bce29fd4
-  data.tar.gz: 42047c6e4d7275f2149d5a7bb50387eb6fc181ab
+  metadata.gz: 4a705b9ebf528ee47ddee8e12713be01d3b89c9b
+  data.tar.gz: aeea9b9165f3106cadca182daa7c3ca5a84b9ed8
 SHA512:
-  metadata.gz: 4d3608f020020a0657c1843baed46704dc4d43d8cab00589de24743e8c6bd42347bfae361dad31ae25fd166ad20cbf2811ea758e5bb7d09da24155608db8c83e
-  data.tar.gz: c5a26090a77829f2c95cb8bee2e7db2a3595348a73d3a8c1a931254334ff960ea736c610891cefc84b6917f9c7d41cdf6aa422556a15b907e9b21cbd9902b8e5
+  metadata.gz: b7c682cbfeb4626c6defc19fed31ec36586efbe05f06dfa27ee885b470e005480eaf775cd513229b58cce944a534b8ee2094e94ef79dd7eb38bb37e72ed63a2f
+  data.tar.gz: 8bd000418bb6cb58b2fe267288b5e53e792411d9062f85c5f84b2620185605b9f4db40c4e80eb2f6a6e55ccd74b81002599a4d1d60a1822e77dc1ab9bb5b9648

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_group 'business_location', 'postnord/business_location'
+  add_group 'shipment', 'postnord/shipment'
+  add_group 'transport', 'postnord/transport'
+end

data/README.md

@@ -1,8 +1,8 @@
 # Postnord
 
-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/postnord`. To experiment with that code, run `bin/console` for an interactive prompt.
+Unofficial Postnord gem for tracking shipments, calculating transmit times and finding service points.
 
-TODO: Delete this and the text above, and describe your gem
+For more information and specifications, please visit https://developer.postnord.com/
 
 ## Installation
 
@@ -22,7 +22,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add configuration to `config/initializers/postnord.rb`:
+
+```ruby
+POSTNORD_API_KEY = 'CHANGEME'
+POSTNORD_API_VERSION = 'v1' # default
+POSTNORD_API_ENDPOINT = 'https://api2.postnord.com/rest' # default
+POSTNORD_LOCALE = 'en' # default
+POSTNORD_RETURN_TYPE = 'json' # default
+```
+
+```
+
+How to fetch a package with the test identifier from [developer documentation](https://developer.postnord.com/docs#!/trackandtrace/findByIdentifier) using a helper method:
+
+```ruby
+> response = Postnord.find_by_identifier('84971563697SE')
+> response.code # => 200
+> response.status # => OK
+> response.data # => {"TrackingInformationResponse"=>{"shipments"=>[]}}
+```
+
+How to calculate transmit time using the class method `call`:
+
+```ruby
+> response = Postnord::GetTransitTimeInformation.call({dateOfDeparture: '2016-04-01', serviceGroupCode: 'SE', fromAddressPostalCode: '11827', fromAddressCountryCode: 'SE', toAddressPostalCode: '98132', toAddressCountryCode: 'SE', serviceCode:'15'})
+> response.data # => {"se.posten.loab.lisp.notis.publicapi.serviceapi.TransitTimeResponse"=>{"transitTimes"=>[{"dateOfDeparture"=>"2016-04-01 18:00:00.0 CEST", "latestTimeOfBooking"=>"14:00", "deliveryTime"=>"17:00", "deliveryDate"=>"20160405", "transitTimeInDays"=>4, "possibleDeviation"=>false, "service"=>{"code"=>"15", "groupCode"=>"SE", "name"=>"DPD Företagspaket", "pickup"=>true, "distribution"=>true}, "daysPickup"=>["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"]}]}}
+```
+
+Validation of parameters:
+```ruby
+> response = Postnord::GetTransitTimeInformation.call({}) # => Postnord::Base::MissingMandatoryParameters: ["serviceGroupCode", "fromAddressPostalCode", "fromAddressCountryCode", "toAddressPostalCode", "toAddressCountryCode"]
+```
 
 ## Development
 
@@ -32,7 +63,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/postnord. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/apoex/postnord. 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

data/lib/postnord/business_location.rb

@@ -2,7 +2,7 @@ module Postnord
 
   # Classes
 
-  class BusinessLocation
+  class BusinessLocation < Base
     def self.service
       'businesslocation'
     end
@@ -12,7 +12,7 @@ module Postnord
     end
   end
 
-  class FindNearestByCoordinates
+  class FindNearestByCoordinates < BusinessLocation
     def mandatory_params
       [
         'countryCode',
@@ -22,7 +22,7 @@ module Postnord
     end
   end
 
-  class FindByPostalCode
+  class FindByPostalCode < BusinessLocation
     def mandatory_params
       [
         'countryCode',
@@ -31,7 +31,7 @@ module Postnord
     end
   end
 
-  class FindNearestByAddress
+  class FindNearestByAddress < BusinessLocation
     def mandatory_params
       [
         'countryCode',
@@ -39,7 +39,7 @@ module Postnord
     end
   end
 
-  class GetServicePointInformation
+  class GetServicePointInformation < BusinessLocation
     def mandatory_params
       []
     end

data/lib/postnord/client.rb

@@ -28,7 +28,7 @@ module Postnord
         http.request(req)
       end
 
-      JSON.parse(res.body)
+      Response.new(res)
     end
 
     private

data/lib/postnord/response.rb

@@ -0,0 +1,33 @@
+module Postnord
+  class Response
+    def initialize(data)
+      @data = data
+      @code = data.code
+      @status = data.msg
+    end
+
+    def code
+      @data.code      
+    end
+
+    def status
+      @data.status
+    end
+
+    def data
+      if @code == "200"
+        JSON.parse(@data.body)
+      else
+        @data.body
+      end
+    end
+
+    def to_h
+      {
+        code: @code,
+        status: @status,
+        data: data,
+      }  
+    end
+  end
+end

data/lib/postnord/transport.rb

@@ -12,8 +12,8 @@ module Postnord
     end
   end
 
-  class GetTransitTimeInformation
-    def mandatory_params
+  class GetTransitTimeInformation < Transport
+    def self.mandatory_params
       [
         'serviceGroupCode',
         'fromAddressPostalCode',

data/lib/postnord/version.rb

@@ -1,3 +1,3 @@
 module Postnord
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/postnord.rb

@@ -3,9 +3,11 @@ require 'net/http'
 require 'net/https'
 require 'json'
 require 'openssl'
-require 'byebug'
 
 require 'postnord/client'
+require 'postnord/response'
 require 'postnord/base'
+require 'postnord/business_location'
 require 'postnord/shipment'
+require 'postnord/transport'
 require 'postnord/version'

data/postnord.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   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 "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postnord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stefan Åhman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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:
 - stefan.ahman@apoex.se
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -72,6 +87,7 @@ files:
 - lib/postnord/base.rb
 - lib/postnord/business_location.rb
 - lib/postnord/client.rb
+- lib/postnord/response.rb
 - lib/postnord/shipment.rb
 - lib/postnord/transport.rb
 - lib/postnord/version.rb