aptible-billing 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7762b872f5e635edf9da78afd40176ca1f61469c
-  data.tar.gz: c8d358f84e5d72479f65bc1db419ebc56a96eb14
+  metadata.gz: 18d3cbfe259be3700b30379d0a68c59aea9be212
+  data.tar.gz: b762d05518e15a05b1da35f31b849ff543c7afa6
 SHA512:
-  metadata.gz: df525f141c80e4c625761855cf3044fdcc17eb93ee7309e288e0fe9467091f75203462299940e0df8d0c122c9b4c808211aaa0ebe34e0af3af46480a3e9e3960
-  data.tar.gz: 44dfc600c43296034fa5c89bec8fb6717707052ae5808ee1b9cd2712eac4454485e4bb5e2c8e7489444ae76d732dc0f847da636b5b07756e22e15a824c5c6e0d
+  metadata.gz: 1ff70c7f14861ce52fb3d97e6a8bbdbbe0f1b4b8f4111c7671435f4452f117ca43d1e4501004a2a2f9dde6035ca9698e897016928e264c567e68fe93046ce88d
+  data.tar.gz: 1d5b1c3a014c34b87ebc493a447e3930b7a6b75fb1a52c13e447a672cb87d7644cc42ee90495c4bf87340dd013a988f8ba796fbcddfb2a2831f8248815063c0f

data/README.md

@@ -1,22 +1,52 @@
-# ![](https://raw.github.com/aptible/straptible/master/lib/straptible/rails/templates/public.api/icon-60px.png) Aptible::Billing::Ruby
+# ![](https://raw.github.com/aptible/straptible/master/lib/straptible/rails/templates/public.api/icon-60px.png) Aptible::Billing
 
-[![Gem Version](https://badge.fury.io/rb/aptible-billing-ruby.png)](https://rubygems.org/gems/aptible-billing-ruby)
+[![Gem Version](https://badge.fury.io/rb/aptible-billing-ruby.png)](https://rubygems.org/gems/aptible-billing)
 [![Build Status](https://travis-ci.org/aptible/aptible-billing-ruby.png?branch=master)](https://travis-ci.org/aptible/aptible-billing-ruby)
 [![Dependency Status](https://gemnasium.com/aptible/aptible-billing-ruby.png)](https://gemnasium.com/aptible/aptible-billing-ruby)
 
-TODO: Add description.
+Ruby client for [billing.aptible.com](https://billing.aptible.com/). Aptible's billing server is built on top of 
+[OAuth 2.0](http://tools.ietf.org/html/rfc6749) and [HAL+JSON](http://tools.ietf.org/html/draft-kelly-json-hal-06), 
+and so this client is just a thin layer on top of the [oauth2](https://github.com/intridea/oauth2) 
+and [HyperResource](https://github.com/gamache/hyperresource) gems.
 
 ## Installation
 
 Add the following line to your application's Gemfile.
 
-    gem 'aptible-billing-ruby'
+    gem 'aptible-billing'
 
 And then run `bundle install`.
 
 ## Usage
 
-TODO: Add usage notes.
+First, get a token:
+
+```ruby
+token = Aptible::Auth::Token.create(email: 'user0@example.com', password: 'password')
+```
+
+From here, you can interact with the Billing API however you wish:
+
+```ruby
+billing_details = Aptible::Billing::BillingDetail.find(id: '1', token: token)
+billing_details.href
+# => "http://localhost:4000/billing_details/1"
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+| --------- | ----------- | --------------- |
+| `root_url` | Root URL of the billing server | `ENV['APTIBLE_BILLING_ROOT_URL']` or [https://billing.aptible.com](https://billing.aptible.com) |
+
+To point the client at a different billing server (e.g., during development), 
+add the following to your application's initializers (or set the `APTIBLE_BILLING_ROOT_URL` environment variable):
+
+```ruby
+Aptible::Billing.configure do |config|
+  config.root_url = 'http://some.other.url'
+end
+```
 
 ## Contributing
 
@@ -29,4 +59,6 @@ TODO: Add usage notes.
 
 MIT License, see [LICENSE](LICENSE.md) for details.
 
-Copyright (c) 2015 [Aptible](https://www.aptible.com), Blake Pettersson, and contributors.
+Copyright (c) 2015 [Aptible](https://www.aptible.com), and contributors.
+
+[<img src="https://s.gravatar.com/avatar/e5b35690e022507eb4df909d11ad4e23?s=60" style="border-radius: 50%;" alt="@blakepettersson" />](https://github.com/blakepettersson)

data/aptible-billing-ruby.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($RS)
-  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.test_files    = spec.files.grep(%r{/^spec/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'stripe', '>= 1.13.0'

data/lib/aptible/billing.rb

@@ -6,10 +6,11 @@ module Aptible
     include GemConfig::Base
 
     with_configuration do
+      override = ENV['APTIBLE_BILLING_ROOT_URL']
       has :root_url,
           classes: [String],
-          default: ENV['APTIBLE_BILLING_ROOT_URL'] || 'https://billing.aptible.com'
-      end
+          default: override || 'https://billing.aptible.com'
+    end
   end
 end
 

data/lib/aptible/billing/billing_detail.rb

@@ -10,7 +10,8 @@ module Aptible
       field :stripe_subscription_id
       field :stripe_subscription_status
       field :plan
-      field :billing_contact_id
+      field :billing_contact
+      field :organization
 
       def stripe_customer
         return nil if stripe_customer_id.nil?
@@ -32,4 +33,4 @@ module Aptible
       end
     end
   end
-end
+end

data/lib/aptible/billing/resource.rb

@@ -14,4 +14,4 @@ module Aptible
   end
 end
 
-require 'aptible/billing/billing_detail'
+require 'aptible/billing/billing_detail'

data/lib/aptible/billing/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module Billing
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/aptible/billing/billing_detail_spec.rb

@@ -1,27 +1,26 @@
 require 'spec_helper'
 
 describe Aptible::Billing::BillingDetail do
-
   describe '#can_manage_compliance?' do
     it 'should return true with compliance plan' do
       subject.stub(:plan) { 'production' }
-      expect(subject.can_manage_compliance?).to be_true
+      expect(subject.can_manage_compliance?).to be true
     end
 
     it 'should return false without compliance plan' do
       subject.stub(:plan) { 'platform' }
-      expect(subject.can_manage_compliance?).to be_false
+      expect(subject.can_manage_compliance?).to be false
     end
   end
 
   describe '#subscribed?' do
     it 'should return true with valid subscription ID' do
       subject.stub(:stripe_subscription_id) { 'sub_4YrmiVa3vMpaGA' }
-      expect(subject.subscribed?).to be_true
+      expect(subject.subscribed?).to be true
     end
 
     it 'should return false without valid subscription ID' do
-      expect(subject.subscribed?).to be_false
+      expect(subject.subscribed?).to be false
     end
   end
-end
+end

data/spec/aptible/billing/resource_spec.rb

@@ -4,4 +4,4 @@ require 'rspec/its'
 describe Aptible::Billing::Resource do
   its(:namespace) { should eq 'Aptible::Billing' }
   its(:root_url) { should eq 'https://billing.aptible.com' }
-end
+end

data/spec/aptible/billing_spec.rb

@@ -20,10 +20,10 @@ describe Aptible::Billing do
 
   it 'should be able to override root_url programatically' do
     config = described_class.configuration
-    Aptible::Billing.configure do |config|
-      config.root_url = 'http://foobar.com'
+    Aptible::Billing.configure do |c|
+      c.root_url = 'http://foobar.com'
     end
 
     expect(config.root_url).to eq 'http://foobar.com'
   end
-end
+end

data/spec/shared/set_env.rb

@@ -1,4 +1,4 @@
-def set_env(*args, &block)
+def set_env(*args, &_block)
   hash = args.first.is_a?(Hash) ? args.first : Hash[*args]
   old_values = Hash[hash.map { |k, _| [k, ENV[k]] }]
   begin
@@ -7,4 +7,4 @@ def set_env(*args, &block)
   ensure
     old_values.each { |k, v| ENV[k] = v }
   end
-end
+end

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ end
 # Require library up front
 require 'aptible/billing'
 
-
 RSpec.configure do |config|
   config.before { Aptible::Billing.configuration.reset }
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-billing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Blake Pettersson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stripe
@@ -170,9 +170,4 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby client for billing.aptible.com
-test_files:
-- spec/aptible/billing/billing_detail_spec.rb
-- spec/aptible/billing/resource_spec.rb
-- spec/aptible/billing_spec.rb
-- spec/shared/set_env.rb
-- spec/spec_helper.rb
+test_files: []