postnord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 625ad1e48069d8cbc99a4b6c526e0a48bce29fd4
+  data.tar.gz: 42047c6e4d7275f2149d5a7bb50387eb6fc181ab
+SHA512:
+  metadata.gz: 4d3608f020020a0657c1843baed46704dc4d43d8cab00589de24743e8c6bd42347bfae361dad31ae25fd166ad20cbf2811ea758e5bb7d09da24155608db8c83e
+  data.tar.gz: c5a26090a77829f2c95cb8bee2e7db2a3595348a73d3a8c1a931254334ff960ea736c610891cefc84b6917f9c7d41cdf6aa422556a15b907e9b21cbd9902b8e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stefan Åhman
+
+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,41 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postnord'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postnord
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[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.
+
+
+## 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 "postnord"
+
+# 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/postnord.rb

@@ -0,0 +1,11 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'openssl'
+require 'byebug'
+
+require 'postnord/client'
+require 'postnord/base'
+require 'postnord/shipment'
+require 'postnord/version'

data/lib/postnord/base.rb

@@ -0,0 +1,37 @@
+module Postnord
+  class Base
+    class MissingMandatoryParameters < StandardError; end
+
+    def self.call(params)
+      validate_params(params)
+
+      client.do_request(service, endpoint, params)
+    end
+
+    def self.client
+      @client ||= Client.new
+    end
+
+    private
+
+    def self.validate_params(params)
+      missing_params = (mandatory_params - params.keys.map(&:to_s))
+
+      unless missing_params.empty?
+        fail MissingMandatoryParameters, missing_params
+      end
+    end
+
+    def self.action
+      self.name.split('::').last.tap { |e| e[0] = e[0].downcase }
+    end
+
+    def self.mandatory_params
+      fail NotImplementedError, 'mandatory_params'
+    end
+
+    def self.endpoint
+      fail NotImplementedError, 'endpoint'
+    end
+  end
+end

data/lib/postnord/business_location.rb

@@ -0,0 +1,47 @@
+module Postnord
+
+  # Classes
+
+  class BusinessLocation
+    def self.service
+      'businesslocation'
+    end
+
+    def self.endpoint
+      "servicepoint/#{action}"
+    end
+  end
+
+  class FindNearestByCoordinates
+    def mandatory_params
+      [
+        'countryCode',
+        'northing',
+        'easting',
+      ]
+    end
+  end
+
+  class FindByPostalCode
+    def mandatory_params
+      [
+        'countryCode',
+        'postalCode',
+      ]
+    end
+  end
+
+  class FindNearestByAddress
+    def mandatory_params
+      [
+        'countryCode',
+      ]
+    end
+  end
+
+  class GetServicePointInformation
+    def mandatory_params
+      []
+    end
+  end
+end

data/lib/postnord/client.rb

@@ -0,0 +1,46 @@
+module Postnord
+  class Client
+    POSTNORD_API_KEY = ''
+    POSTNORD_API_VERSION = 'v1'
+    POSTNORD_API_ENDPOINT = 'https://api2.postnord.com/rest'
+    POSTNORD_LOCALE = 'en'
+    POSTNORD_RETURN_TYPE = 'json'
+
+    def initialize(options={})
+      @api_version = options[:api_version] || POSTNORD_API_VERSION
+      @api_key = options[:api_key] || POSTNORD_API_KEY
+      @locale = options[:locale] || POSTNORD_LOCALE || 'en'
+      @returntype = options[:returntype] || POSTNORD_RETURN_TYPE || 'json'
+    end
+
+    def do_request(service, endpoint, params={})
+      uri = build_uri(service, endpoint)
+
+      params.merge!(
+        apikey: POSTNORD_API_KEY,
+        locale: POSTNORD_LOCALE,
+      )
+
+      uri.query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new(uri)
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      JSON.parse(res.body)
+    end
+
+    private
+
+    def build_uri(service, endpoint)
+      URI(
+        POSTNORD_API_ENDPOINT +
+        '/' + service +
+        '/' + POSTNORD_API_VERSION +
+        '/' + endpoint +
+        '.' + POSTNORD_RETURN_TYPE
+      )
+    end
+  end
+end

data/lib/postnord/shipment.rb

@@ -0,0 +1,60 @@
+module Postnord
+
+  # Helper methods
+
+  def self.find_by_identifier(id)
+    FindByIdentifier.call(
+      id: id,
+    )
+  end
+
+  def self.find_by_notification_code(phone_number, notification_code)
+    FindByNotificationCode.call(
+      notificationPhoneNumber: phone_number,
+      notificationCode: notification_code,
+    )
+  end
+
+  def self.find_by_reference(customer_number, reference_value)
+    FindByReference.call(
+      customerNumber: customer_number,
+      referenceValue: reference_value,
+    )
+  end
+
+  # Classes
+
+  class Shipment < Base
+    def self.service
+      'shipment'
+    end
+
+    def self.endpoint
+      "trackandtrace/#{action}"
+    end
+  end
+
+  class FindByIdentifier < Shipment
+    def self.mandatory_params
+      ['id']
+    end
+  end
+
+  class FindByNotificationCode < Shipment
+    def self.mandatory_params
+      [
+        'notificationPhoneNumber',
+        'notificationCode',
+      ]
+    end
+  end
+
+  class FindByReference < Shipment
+    def self.mandatory_params
+      [
+        'customerNumber',
+        'referenceValue',
+      ]
+    end
+  end
+end

data/lib/postnord/transport.rb

@@ -0,0 +1,26 @@
+module Postnord
+
+  # Classes
+
+  class Transport < Base
+    def self.service
+      'transport'
+    end
+
+    def self.endpoint
+      "transittime/#{action}"
+    end
+  end
+
+  class GetTransitTimeInformation
+    def mandatory_params
+      [
+        'serviceGroupCode',
+        'fromAddressPostalCode',
+        'fromAddressCountryCode',
+        'toAddressPostalCode',
+        'toAddressCountryCode',
+      ]
+    end
+  end
+end

data/lib/postnord/version.rb

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

data/postnord.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postnord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "postnord"
+  spec.version       = Postnord::VERSION
+  spec.authors       = ["Stefan Åhman"]
+  spec.email         = ["stefan.ahman@apoex.se"]
+
+  spec.summary       = %q{A gem for Postnord's API}
+  spec.homepage      = 'https://github.com/apoex/postnord-gem'
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: postnord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Åhman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- stefan.ahman@apoex.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/postnord.rb
+- lib/postnord/base.rb
+- lib/postnord/business_location.rb
+- lib/postnord/client.rb
+- lib/postnord/shipment.rb
+- lib/postnord/transport.rb
+- lib/postnord/version.rb
+- postnord.gemspec
+homepage: https://github.com/apoex/postnord-gem
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for Postnord's API
+test_files: []