vault-invoice-builder-client 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+.rvmrc
+.yardoc/
+doc/
+vendor/
+test/.test*

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'rake'
+end
+
+group :test do
+  gem 'rr'
+  gem 'vault-test-tools', '~> 0.2.2', :git => 'https://github.com/heroku/vault-test-tools.git'
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GIT
+  remote: https://github.com/heroku/vault-test-tools.git
+  revision: 5eabd67610f279b81cadb803cee8ef704093a05d
+  specs:
+    vault-test-tools (0.2.2)
+      minitest
+      nokogiri
+      rack-perftools_profiler
+      rack-test
+      rdoc
+      redcarpet
+      turn
+      yard
+
+PATH
+  remote: .
+  specs:
+    vault-invoice-builder-client (0.0.2)
+      excon
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    excon (0.16.10)
+    json (1.7.7)
+    minitest (4.6.0)
+    nokogiri (1.5.6)
+    open4 (1.3.0)
+    perftools.rb (2.0.0)
+    rack (1.5.2)
+    rack-perftools_profiler (0.6.0)
+      open4 (~> 1.0)
+      perftools.rb (~> 2.0.0)
+      rack (~> 1.0)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    redcarpet (2.2.2)
+    rr (1.0.4)
+    turn (0.9.6)
+      ansi
+    yajl-ruby (1.1.0)
+    yard (0.8.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rr
+  vault-invoice-builder-client!
+  vault-test-tools (~> 0.2.2)!

data/README.md

@@ -0,0 +1,67 @@
+# Vault::InvoiceBuilder::Client
+
+A Ruby client for the `Vault::InvoiceBuilder` HTTP API.
+
+## Setting up a development environment
+
+Install dependencies and run the test suite:
+
+    bundle install --binstubs vendor/bin
+    rbenv rehash
+    rake
+
+Run tests:
+
+    rake test
+
+See tasks:
+
+    rake -T
+
+Generate API documentation:
+
+    rake yard
+
+## Using the client
+
+The `Vault::InvoiceBuilder` API may only be accessed anonymously:
+
+```ruby
+require 'vault-invoice-builder-client'
+
+client = Vault::InvoiceBuilder::Client.new(
+  'https://vault-invoice-builder.herokuapp.com')
+```
+
+For endpoints that require authentication, HTTP Basic credentials must
+be supplied in the URL:
+
+```ruby
+client = Vault::InvoiceBuilder::Client.new(
+  'https://username:password@vault-invoice-builder.herokuapp.com')
+```
+
+### Rendering an invoice.
+
+An invoice contains customer contact and tax details, a list of apps
+and the charges they've incurred by consuming dyno hours and using
+addons, a list of charges for products the customer used directly,
+such as a support contract, and credits that have been applied to
+cover some or all of the charges on the invoice.  An invoice is
+rendered from a receipt, a JSON representation of app and user charges
+and credits.
+
+```ruby
+receipt = {user: 'user123@heroku.com', start_time: …, …}
+html_content = client.render_html(receipt)
+```
+
+### Storing an invoice
+The `store` method can be used to render an invoice and then store it
+to S3.  The same receipt JSON object is passed and an empty 200 OK
+response is returned if the request was successful.
+
+```ruby
+receipt = {user: 'user123@heroku.com', start_time: …, …}
+response = client.store(receipt)
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'yard'
+
+desc "Test the things"
+require 'vault-test-tools/rake_task'
+
+desc "Doc the things"
+YARD::Rake::YardocTask.new
+
+desc "Run the test suite"
+task :default => [:test]

data/lib/vault-invoice-builder-client.rb

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler.require :default, ENV['RACK_ENV'].to_sym
+
+require 'excon'
+require 'yajl/json_gem'
+
+module Vault
+  module InvoiceBuilder
+    # Client provides a Ruby API to access the `Vault::InvoiceBuilder` HTTP
+    # API.
+    class Client
+    end
+  end
+end
+
+require 'vault-invoice-builder-client/client'
+require 'vault-invoice-builder-client/version'

data/lib/vault-invoice-builder-client/client.rb

@@ -0,0 +1,67 @@
+module Vault::InvoiceBuilder
+  # Client for the `Vault::InvoiceBuilder` HTTP API.
+  class Client
+    # The `Vault::InvoiceBuilder` HTTP API URL.
+    attr_reader :url
+
+    # Instantiate a client.
+    #
+    # @param url [String] The URL to connect to.  Include the username and
+    #   password to use when connecting.  Defaults to the URL defined in the
+    #   `VAULT_INVOICE_BUILDER_URL` environment variable if one isn't
+    #   explicitly provided.
+    def initialize(url = nil)
+      @url = url || ENV['VAULT_INVOICE_BUILDER_URL']
+    end
+
+    # Render a statement into an HTML invoice.
+    #
+    # @param statement [Hash] An object matching the statement format described in
+    #   the `Vault::InvoiceBuilder` README.
+    # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
+    #   unsuccessful HTTP status code.
+    # @return [String] The rendered HTML invoice.
+    def render_html(statement)
+      connection = Excon.new(@url)
+      response = connection.post(
+        path: "/invoice.html",
+        headers: {'Content-Type' => 'application/json'},
+        body: JSON.generate(statement),
+        expects: [200])
+      response.body
+    end
+
+    # POST a statement to to the proxy-able /statement/:id endpoint
+    #
+    # @param statement [Hash] An object matching the statement format described in
+    #   the `Vault::InvoiceBuilder` README.
+    # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
+    #   unsuccessful HTTP status code.
+    # @return [Excon::Response] The response object.
+    def post(statement)
+      connection = Excon.new(@url)
+      id = statement[:id] || statement['id']
+      response = connection.post(
+        path: "/statement/#{id}",
+        headers: {'Content-Type' => 'application/json'},
+        body: JSON.generate(statement),
+        expects: [200])
+    end
+
+    # @deprecated
+    #
+    # @param statement [Hash] An object matching the statement format described in
+    #   the `Vault::InvoiceBuilder` README.
+    # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
+    #   unsuccessful HTTP status code.
+    # @return [Excon::Response] The response object.
+    def store(statement)
+      connection = Excon.new(@url)
+      response = connection.post(
+        path: '/store',
+        headers: {'Content-Type' => 'application/json'},
+        body: JSON.generate(statement),
+        expects: [200])
+    end
+  end
+end

data/lib/vault-invoice-builder-client/version.rb

@@ -0,0 +1,8 @@
+module Vault
+  module InvoiceBuilder
+    class Client
+      # The `Vault::InvoiceBuilder::Client` gem version.
+      VERSION = '0.0.2'
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,132 @@
+require 'helper'
+
+class ClientTest < Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
+
+  def setup
+    super
+    Excon.stubs.clear
+    Excon.defaults[:mock] = true
+    @client = Vault::InvoiceBuilder::Client.new(
+      'https://vault-invoice-builder.herokuapp.com')
+    @statement = {user: 'user123@heroku.com',
+                start_time: Time.utc(2012, 1),
+                stop_time: Time.utc(2012, 2)}
+  end
+
+  def teardown
+    # FIXME This is a bit ugly, but Excon doesn't provide a builtin way to
+    # ensure that a request was invoked, so we have to do it ourselves.
+    # Without this, and the Excon.stubs.pop calls in the tests below, tests
+    # will pass if request logic is completely removed from application
+    # code. -jkakar
+    assert(Excon.stubs.empty?, 'Expected HTTP requests were not made.')
+    super
+  end
+
+  # Client.new looks for VAULT_INVOICE_BUILDER_URL if none is passed to the
+  # constructor.
+  def test_uses_url_from_environment_by_default
+    url = 'http://example.com'
+    set_env 'VAULT_INVOICE_BUILDER_URL', url
+    @client = Vault::InvoiceBuilder::Client.new
+    assert_equal(url, @client.url)
+  end
+
+  # Client.render_html makes a PUT request to the Vault::InvoiceBuilder HTTP
+  # API, passing the supplied credentials using HTTP basic auth, to report
+  # that usage of a product began at a particular time.
+  def test_render_html
+    content = '<html><body><p>Hello, world!</p></body></html>'
+    Excon.stub(method: :post) do |request|
+      assert_equal('vault-invoice-builder.herokuapp.com:443',
+                   request[:host_port])
+      assert_equal("/invoice.html", request[:path])
+      Excon.stubs.pop
+      {status: 200, body: content}
+    end
+    assert_equal(content, @client.render_html(@statement))
+  end
+
+  # Client.render_html raises the appropriate Excon::Errors::HTTPStatusError
+  # if an unsuccessful HTTP status code is returned by the server.
+  def test_render_html_with_unsuccessful_response
+    Excon.stub(method: :post) do |request|
+      Excon.stubs.pop
+      {status: 400, body: 'Bad inputs provided.'}
+    end
+    assert_raises Excon::Errors::BadRequest do
+      @client.render_html(@statement)
+    end
+  end
+
+  # Client.store makes a POST request to the Vault::InvoiceBuilder HTTP API,
+  # passing the supplied credentials using HTTP Basic Auth, to which triggers
+  # Vault::InvoiceBuilder to generate the invoice and store it to S3.
+  def test_store
+    Excon.stub(method: :post) do |request|
+      assert_equal('vault-invoice-builder.herokuapp.com:443',
+                   request[:host_port])
+      assert_equal('/store', request[:path])
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      Excon.stubs.pop
+      {status: 200}
+    end
+    response = @client.store(@statement)
+    assert_equal(200, response.status)
+  end
+
+  # Client.store raises the appropriate Excon::Errors::HTTPStatusError if an
+  # unsuccessful HTTP status code is returned by the server.
+  def test_store_with_unsuccessful_response
+    Excon.stub(method: :post) do |request|
+      Excon.stubs.pop
+      {status: 400, body: 'Bad inputs provided.'}
+    end
+    assert_raises Excon::Errors::BadRequest do
+      @client.store(@statement)
+    end
+  end
+
+  # Client.post makes a POST request to the canonical statement drain API
+  def test_post_with_symbol_id_key
+    @statement[:id] = 1
+    Excon.stub(method: :post) do |request|
+      assert_equal('vault-invoice-builder.herokuapp.com:443',
+                   request[:host_port])
+      assert_equal('/statement/1', request[:path])
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      Excon.stubs.pop
+      {status: 200}
+    end
+    response = @client.post(@statement)
+    assert_equal(200, response.status)
+  end
+
+  # Client.post makes a POST request to the canonical statement drain API
+  def test_post_with_string_id_key
+    @statement['id'] = 1
+    Excon.stub(method: :post) do |request|
+      assert_equal('vault-invoice-builder.herokuapp.com:443',
+                   request[:host_port])
+      assert_equal('/statement/1', request[:path])
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      Excon.stubs.pop
+      {status: 200}
+    end
+    response = @client.post(@statement)
+    assert_equal(200, response.status)
+  end
+
+  # Client.store raises the appropriate Excon::Errors::HTTPStatusError if an
+  # unsuccessful HTTP status code is returned by the server.
+  def test_post_with_unsuccessful_response
+    Excon.stub(method: :post) do |request|
+      Excon.stubs.pop
+      {status: 400, body: 'Bad inputs provided.'}
+    end
+    assert_raises Excon::Errors::BadRequest do
+      @client.post(@statement)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'vault-invoice-builder-client'
+require 'vault-test-tools'

data/test/version_test.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class VersionTest < Vault::TestCase
+  # Vault::InvoiceBuilder::Client::VERSION is a string matching the
+  # `major.minor.patch` format.
+  def test_version
+    assert_match(/\d+\.\d+\.\d+/, Vault::InvoiceBuilder::Client::VERSION)
+  end
+end

data/vault-invoice-builder-client.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vault-invoice-builder-client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vault-invoice-builder-client"
+  gem.version       = Vault::InvoiceBuilder::Client::VERSION
+  gem.authors       = ["Chris Continanza", "Jamu Kakar", "Matthew Manning"]
+  gem.email         = ["csquared@heroku.com", "jkakar@heroku.com",
+                       "matthew@heroku.com"]
+  gem.description   = "Client for Vault::InvoiceBuilder"
+  gem.summary       = "A simple wrapper for the Vault::InvoiceBuilder HTTP API"
+  gem.homepage      = "https://github.com/heroku/vault-invoice-builder-client"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep('^(test|spec|features)/')
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'excon'
+  gem.add_dependency 'yajl-ruby'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: vault-invoice-builder-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Chris Continanza
+- Jamu Kakar
+- Matthew Manning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for Vault::InvoiceBuilder
+email:
+- csquared@heroku.com
+- jkakar@heroku.com
+- matthew@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/vault-invoice-builder-client.rb
+- lib/vault-invoice-builder-client/client.rb
+- lib/vault-invoice-builder-client/version.rb
+- test/client_test.rb
+- test/helper.rb
+- test/version_test.rb
+- vault-invoice-builder-client.gemspec
+homepage: https://github.com/heroku/vault-invoice-builder-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3070326704752709441
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3070326704752709441
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the Vault::InvoiceBuilder HTTP API
+test_files: []
+has_rdoc: