bring 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97d5eec883fe2e9e432dfe019281bde0a2d1994f
+  data.tar.gz: 1849980a27923652ee5eaec13c21abd5a7c4f828
+SHA512:
+  metadata.gz: a32c9f8183a00f32d1d63449751e1f0445ae6d2828ca5bee4b8b0c98bf4941f1f617d7342d007255da94963feb4510e7f1e4a30b20a19647bfd7ded10922999f
+  data.tar.gz: 50f6f069b0c1ebee7ae5adeb587538377a9a27d7255a4d8256d0e72f45a541e391b40b0a1192aed984faabbb0d6133963446047575d38592dc0753d357612ae4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/fixtures/vcr_cassettes
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Erlend Finvåg
+
+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,43 @@
+# Bring
+
+[![Build Status](https://travis-ci.org/wepack/bring.png)](https://travis-ci.org/wepack/bring)
+
+A simple ruby library for communicating with the Bring's APIs (see:
+[developer.bring.com](http://developer.bring.com)).
+
+*For now only the Postal Code API is supported.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bring'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bring
+
+## Usage
+
+From the commandline:
+
+    $ bring postal_code 0190 no
+    OSLO
+
+Or in Ruby:
+```ruby
+require 'bring/postal_code'
+Bring::PostalCode.new('0190', country: 'no).city # => 'OSLO'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

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/bring

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bring/cli'
+Bring::CLI.start

data/bring.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bring"
+  spec.version       = Bring::VERSION
+  spec.authors       = ["Erlend Finvåg"]
+  spec.email         = ["erlend.finvag@gmail.com"]
+  spec.description   = %q{A simple utility for Bring's APIs}
+  spec.summary       = %q{Command line client and Ruby library for bring's APIs}
+  spec.homepage      = "https://github.com/wepack/bring"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "vcr"
+
+  spec.add_runtime_dependency "thor"
+
+  spec.add_dependency "faraday", "~> 0.8.0"
+  spec.add_dependency "faraday_middleware"
+
+  spec.add_dependency "json" if RUBY_VERSION.start_with?('1.8')
+end

data/lib/bring/base_request.rb

@@ -0,0 +1,16 @@
+require 'bring/configurator'
+require 'faraday_middleware'
+
+module Bring
+  class BaseRequest
+
+    private
+    def connection
+      @connection ||= Faraday.new(api_url) do |conn|
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter Bring.config.faraday_adapter || Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/bring/cli.rb

@@ -0,0 +1,12 @@
+require 'thor'
+
+module Bring
+  class CLI < Thor
+    desc 'postal_code PNR', 'get city from PNR'
+    option :country, :default => 'no'
+    def postal_code(pnr)
+      require 'bring/postal_code'
+      puts PostalCode.new(pnr, :country => options[:country]).city
+    end
+  end
+end

data/lib/bring/configurator.rb

@@ -0,0 +1,17 @@
+require 'singleton'
+
+module Bring
+  def self.config(&block)
+    config = Bring::Configurator.instance
+    yield config if block_given?
+
+    config
+  end
+
+  class Configurator
+    include Singleton
+
+    # Specify Faraday adapter or use `Faraday.default_adapter` by default.
+    attr_accessor :faraday_adapter
+  end
+end

data/lib/bring/postal_code.rb

@@ -0,0 +1,32 @@
+require 'bring/base_request'
+
+module Bring
+  class PostalCode < BaseRequest
+    @@cities = {}
+    attr_reader :postal_code, :country
+
+    def self.reset_cache!
+      @@cities.clear
+    end
+
+    def initialize(pnr, options = {})
+      @postal_code, @country = pnr, options[:country]
+    end
+
+    def city
+      @@cities[postal_code] ||= request.body['result']
+    end
+
+    private
+    def request
+      connection.get do |req|
+       req.params['pnr']     = postal_code
+       req.params['country'] = country
+      end
+    end
+
+    def api_url
+      'http://fraktguide.bring.no/fraktguide/api/postalCode.json'.freeze
+    end
+  end
+end

data/lib/bring/version.rb

@@ -0,0 +1,3 @@
+module Bring
+  VERSION = "0.0.1"
+end

data/lib/bring.rb

@@ -0,0 +1,5 @@
+require 'bring/version'
+require 'bring/configurator'
+
+module Bring
+end

data/spec/bring/base_request_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'bring/base_request'
+
+class MockRequest < Bring::BaseRequest
+  def api_url
+    'http://example.org/foo.json'.freeze
+  end
+
+  def connection
+    super
+  end
+end
+
+describe Bring::BaseRequest do
+  let(:base_request) { MockRequest.new }
+
+  describe 'connection' do
+    it 'returns faraday connection' do
+      expect(base_request.connection).to be_a Faraday::Connection
+    end
+  end
+end

data/spec/bring/cli_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'bring/cli'
+
+describe Bring::CLI, :vcr do
+  def invoke!(*args)
+    capture(:stdout) { Bring::CLI.start(args) }
+  end
+
+  describe 'postal_code' do
+    it 'displays city for pnr' do
+      expect(invoke! 'postal_code', '0190').to eq "OSLO\n"
+    end
+
+    it 'takes a country' do
+      arguments = %w[postal_code 12000 --country se]
+      expect(invoke!(*arguments)).to eq "Stockholm\n"
+    end
+  end
+end

data/spec/bring/configurator_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'bring/configurator'
+
+describe Bring::Configurator do
+  let(:configurator) { Bring::Configurator.instance }
+
+  describe 'self.configuration' do
+    it 'returns self' do
+      expect(Bring.config).to be configurator
+    end
+
+    it 'takes a block' do
+      expect(configurator).to receive(:foo).and_return('bar')
+
+      Bring.config do |config|
+        expect(config.foo).to eq 'bar'
+      end
+    end
+  end
+end

data/spec/bring/postal_code_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'bring/postal_code'
+
+describe Bring::PostalCode do
+  describe 'city', :vcr do
+    before do
+      Bring::PostalCode.reset_cache!
+    end
+
+    it "fetches result from Bring's API" do
+      postal_code = Bring::PostalCode.new('0190')
+
+      expect(postal_code.city).to eq 'OSLO'
+    end
+
+    it "keeps result in memory" do
+      Bring::PostalCode.new('0190').city
+
+      expect { Bring::PostalCode.new('0190').city }.not_to raise_error
+    end
+
+    it 'fetches result for different countries' do
+      postal_code = Bring::PostalCode.new('12000', :country => 'se')
+
+      expect(postal_code.city).to eq 'Stockholm'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir =
+    File.expand_path('../fixtures/vcr_cassettes', __FILE__)
+
+  config.hook_into :faraday
+  config.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  # This will be default behaviour in RSpec 3
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: bring
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Erlend Finvåg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: thor
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: A simple utility for Bring's APIs
+email:
+- erlend.finvag@gmail.com
+executables:
+- bring
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bring
+- bring.gemspec
+- lib/bring.rb
+- lib/bring/base_request.rb
+- lib/bring/cli.rb
+- lib/bring/configurator.rb
+- lib/bring/postal_code.rb
+- lib/bring/version.rb
+- spec/bring/base_request_spec.rb
+- spec/bring/cli_spec.rb
+- spec/bring/configurator_spec.rb
+- spec/bring/postal_code_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wepack/bring
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Command line client and Ruby library for bring's APIs
+test_files:
+- spec/bring/base_request_spec.rb
+- spec/bring/cli_spec.rb
+- spec/bring/configurator_spec.rb
+- spec/bring/postal_code_spec.rb
+- spec/spec_helper.rb