sendle-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e8ccaab4d83714d1b4ca21fa6c187fa8bce1513
+  data.tar.gz: f8df1382bd0eb6578e1c8c3dc0673d9b024ff647
+SHA512:
+  metadata.gz: f940dc5aac60f8dbe72dd19caa5919c88f27167702b43f072310064fbe45e69f32b3478d027eb71cade3d55a7183b2e642ee38aa439b62df72d45912be76c973
+  data.tar.gz: e243834ebc730d86c9a6d775e8249c52df7a07e08cfec50b0ce58a5940e64375d2c7452ab463c236b616ec7e36734d9193a960802e5d429c116c9be1054921b9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.byebug_history

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 mebobby2
+
+MIT License
+
+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,44 @@
+# Sendle::Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sendle-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendle-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sendle-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Notes
+### Development
+1. Navigate to root of this project
+2. Run bundle install to install the gems specified in sendle-api.gemspec
+3. Run bundle exec rake spec to run the tests
+
+### Release
+1. Make sure you have a RubyGems.org account
+2. bundle exec rake release
+
+### Guide 
+Based on this guide: https://quickleft.com/blog/engineering-lunch-series-step-by-step-guide-to-building-your-first-ruby-gem

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+

data/lib/sendle/api.rb

@@ -0,0 +1,15 @@
+require "sendle/api/version"
+
+module Sendle
+  module Api
+
+    class << self
+      attr_accessor :api_key, :sendle_id
+
+      def base_url
+        "https://sandbox.sendle.com/api/"
+      end
+    end
+    
+  end
+end

data/lib/sendle/api/actions/index.rb

@@ -0,0 +1,25 @@
+require 'rest-client'
+
+module Sendle
+  module Api
+    module Actions
+      module Index
+        
+        def index
+          Sendle::Api::Utils::Actions.check_for_missing_credentials
+          RestClient::Request.execute(
+            method: :get,
+            url: self.url,
+            user: Sendle::Api.sendle_id,
+            password: Sendle::Api.api_key,
+            headers: Sendle::Api::Utils::Actions.json_headers
+          )
+          Sendle::Api::Responses::Pong.new
+        rescue RestClient::Unauthorized => e 
+          response = JSON.parse(e.response)
+          raise Sendle::Api::Errors::Unauthorized.new(response['error_description'])
+        end
+      end
+    end
+  end
+end

data/lib/sendle/api/errors/missing_api_key.rb

@@ -0,0 +1,9 @@
+module Sendle
+  module Api
+    module Errors
+      class MissingApiKey < StandardError
+
+      end
+    end
+  end
+end

data/lib/sendle/api/errors/missing_sendle_id.rb

@@ -0,0 +1,9 @@
+module Sendle
+  module Api
+    module Errors
+      class MissingSendleId < StandardError
+
+      end
+    end
+  end
+end

data/lib/sendle/api/errors/unauthorized.rb

@@ -0,0 +1,9 @@
+module Sendle
+  module Api
+    module Errors
+      class Unauthorized < StandardError
+
+      end
+    end
+  end
+end

data/lib/sendle/api/ping.rb

@@ -0,0 +1,11 @@
+class Sendle::Api::Ping
+  extend Sendle::Api::Actions::Index
+
+  class << self
+    alias_method :execute, :index
+  end
+
+  def self.url
+    Sendle::Api.base_url + "ping"
+  end
+end

data/lib/sendle/api/responses/pong.rb

@@ -0,0 +1,9 @@
+module Sendle
+  module Api
+    module Responses
+      class Pong
+
+      end
+    end
+  end
+end

data/lib/sendle/api/version.rb

@@ -0,0 +1,5 @@
+module Sendle
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/sendle/utils/actions.rb

@@ -0,0 +1,19 @@
+module Sendle
+  module Api
+    module Utils
+      class Actions
+
+        def self.check_for_missing_credentials
+          raise Sendle::Api::Errors::MissingSendleId if Sendle::Api.sendle_id.nil?
+          raise Sendle::Api::Errors::MissingApiKey if Sendle::Api.api_key.nil?
+        end
+
+        def self.json_headers
+          { accept: :json, content_type: :json }
+        end
+
+      end
+    end
+  end
+
+end

data/sendle-api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendle/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendle-api"
+  spec.version       = Sendle::Api::VERSION
+  spec.authors       = ["Bobby Lei"]
+  spec.email         = ["bobl53@gmail.com"]
+  spec.summary       = "Ruby bindings for the Sendle API"
+  spec.description   = "Sendle allows businesses to send parcels door to door for low flat-rates Australia wide. See https://www.sendle.com for details."
+  spec.homepage      = "http://api-doc.sendle.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "require_all"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency('rest-client')
+end

data/spec/sendle/api/ping_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Sendle::Api::Ping do
+
+  let(:api_key) { 'fake-key' }
+  let(:sendle_id) { 'fake-id' }
+
+  before do
+    Sendle::Api.api_key = api_key
+    Sendle::Api.sendle_id = sendle_id
+  end
+
+  describe "#execute" do
+    it_behaves_like "a resource action with credentials"
+
+    it "makes the correct request" do
+      expected_params = json_headers.merge(
+        method: :get,
+        url: Sendle::Api::Ping.url,
+        user: sendle_id,
+        password: api_key
+      )
+      expect(RestClient::Request).to receive(:execute).with(hash_including(expected_params))
+
+      Sendle::Api::Ping.execute
+    end
+
+    it "returns a pong" do
+      expect(RestClient::Request).to receive(:execute)
+
+      pong = Sendle::Api::Ping.execute
+
+      expect(pong).to be_a Sendle::Api::Responses::Pong
+    end
+
+    it "handles unauthorized" do
+      expect(RestClient::Request).to receive(:execute).and_raise(UNAUTHORIZED_ERROR)
+
+      expect {
+        Sendle::Api::Ping.execute
+      }.to raise_error(Sendle::Api::Errors::Unauthorized)
+    end
+  end
+
+end

data/spec/sendle/api_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Sendle::Api do
+  
+  it "allows setting of the api_key" do
+    api_key = "testing-api-key"
+
+    Sendle::Api.api_key = api_key
+
+    expect(Sendle::Api.api_key).to eq api_key
+  end
+
+  it "allows setting the sendle_id" do
+    sendle_id = "testing-sendle-id"
+
+    Sendle::Api.sendle_id = sendle_id
+
+    expect(Sendle::Api.sendle_id).to eq sendle_id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'byebug'
+require 'require_all'
+
+require_all 'spec/support'
+require_all 'lib/sendle'

data/spec/support/helpers.rb

@@ -0,0 +1,7 @@
+require 'rest-client'
+
+def json_headers
+  { headers: { accept: :json, content_type: :json } }
+end
+
+UNAUTHORIZED_ERROR = RestClient::Unauthorized.new("{\"error\":\"unauthorised\",\"error_description\":\"The authorisation details are not valid. Either the Sendle ID or API key are incorrect.\"}")

data/spec/support/shared_examples/with_credentials_spec.rb

@@ -0,0 +1,39 @@
+shared_examples_for "a resource action with credentials" do
+
+  describe "setting of credentials" do
+    described_resource = example.metadata[:described_class]
+    described_action = example.metadata[:example_group][:parent_example_group][:parent_example_group][:description_args].first.gsub("#", "")
+
+    before do
+      allow(RestClient::Request).to receive(:execute)
+    end
+
+    it "throws an missing sendle_id error" do
+      Sendle::Api.sendle_id = nil
+      Sendle::Api.api_key = 'fake-key'
+
+      expect {
+        described_resource.send(described_action)
+      }.to raise_error Sendle::Api::Errors::MissingSendleId
+    end
+
+    it "throws an missing api_key error" do
+      Sendle::Api.sendle_id = 'fake-id'
+      Sendle::Api.api_key = nil
+
+      expect {
+        described_resource.send(described_action)
+      }.to raise_error Sendle::Api::Errors::MissingApiKey
+    end
+
+    it "does not throw errors if both api_key and sendle_id are set" do
+      Sendle::Api.sendle_id = 'sdfsfdsf'
+      Sendle::Api.api_key = 'sdfsfdsf'
+
+      expect {
+        described_resource.send(described_action)
+      }.to_not raise_error 
+    end
+  end
+
+end

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color']
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: sendle-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bobby Lei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+description: Sendle allows businesses to send parcels door to door for low flat-rates
+  Australia wide. See https://www.sendle.com for details.
+email:
+- bobl53@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sendle/api.rb
+- lib/sendle/api/actions/index.rb
+- lib/sendle/api/errors/missing_api_key.rb
+- lib/sendle/api/errors/missing_sendle_id.rb
+- lib/sendle/api/errors/unauthorized.rb
+- lib/sendle/api/ping.rb
+- lib/sendle/api/responses/pong.rb
+- lib/sendle/api/version.rb
+- lib/sendle/utils/actions.rb
+- sendle-api.gemspec
+- spec/sendle/api/ping_spec.rb
+- spec/sendle/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples/with_credentials_spec.rb
+- tasks/rspec.rake
+homepage: http://api-doc.sendle.com
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Sendle API
+test_files:
+- spec/sendle/api/ping_spec.rb
+- spec/sendle/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples/with_credentials_spec.rb