billingbadger_api 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2012-06-04
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/billingbadger_api.rb
+script/console
+script/destroy
+script/generate
+test/test_billingbadger_api.rb
+test/test_helper.rb
+docs/billingbadger_api.yml.example
+lib/billingbadger/objects/product.rb
+lib/billingbadger/objects/subscription.rb
+lib/billingbadger/objects/customer.rb
+lib/billingbadger/objects/invoice_item.rb
+lib/billingbadger/objects/invoice.rb
+lib/billingbadger/objects/periodic_invoice.rb
+lib/billingbadger/objects/product_group.rb
+lib/billingbadger/my_active_resource.rb
+rails/init.rb

data/README.rdoc

@@ -0,0 +1,54 @@
+= billingbadger_api
+
+* http://github.com/cmdjohnson/billingbadger_api
+
+== DESCRIPTION:
+
+API gem for Billing Badger. 
+
+== FEATURES/PROBLEMS:
+
+Gives you a bunch of classes to work with as if they were in your own database.
+
+== SYNOPSIS:
+
+You have various classes at your disposal such as Billingbadger::Product, Billingbadger::Subscription, Billingbadger::Customer, etc.
+
+This gem leans heavily on ActiveResource. This means you can use all ActiveResource commands on these classes.
+
+See http://api.rubyonrails.org/classes/ActiveResource/Base.html for more information. The example is using the class Person, just replace that with any of the Badger object names (e.g. Billingbadger::Product).
+
+== REQUIREMENTS:
+
+ - active_resource
+ - yaml
+
+== INSTALL:
+
+ - Add 'billingbadger_api' to your Gemfile
+ - Create a config file config/billingbadger_api.yml according to the example in the 'doc' folder
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Commander Johnson <commanderjohnson@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/billingbadger_api'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'billingbadger_api' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  #self.extra_deps         = [['activeresource','>= 2.3.14']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/docs/billingbadger_api.yml.example

@@ -0,0 +1,14 @@
+# Example config file to access the Billing Badger API.
+# 1. Create a User account at the endpoint, keep note of your username/email and password
+# 2. Copy this file to a file called config/billingbadger_api.yml
+# 3. Fill in the correct username and password
+# 4. All set!
+---
+  # BEGIN EDITABLE SECTION
+  username: "john.doe@example.com"
+  password: "deadbeef123"
+  # END EDITABLE SECTION
+  # ----------------------------------------------------------------------------
+  # No need to edit beyound this line
+  # ----------------------------------------------------------------------------
+  endpoint: "https://api.billingbadger.com"

data/lib/billingbadger/my_active_resource.rb

@@ -0,0 +1,12 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+class MyActiveResource < ActiveResource::Base
+  def self.config
+    YAML::load_file("config/billingbadger_api.yml")
+  end
+
+  self.site = config["endpoint"]
+  self.user = config["username"]
+  self.password = config["password"]
+end

data/lib/billingbadger/objects/customer.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class Customer < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/invoice.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class Invoice < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/invoice_item.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class InvoiceItem < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/periodic_invoice.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class PeriodicInvoice < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/product.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class Product < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/product_group.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class ProductGroup < MyActiveResource
+  end
+end

data/lib/billingbadger/objects/subscription.rb

@@ -0,0 +1,7 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Billingbadger
+  class Subscription < MyActiveResource
+  end
+end

data/lib/billingbadger_api.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'active_resource'
+require 'yaml'
+
+# Require all the Ruby files in the Billing Badger directory.
+require 'billingbadger/my_active_resource'
+# this doesn't work with Rails & Bundler :((
+Dir.glob('lib/billingbadger/objects/*.rb') {|file| require file}  
+
+module BillingbadgerApi
+  VERSION = '0.0.1'
+end

data/rails/init.rb

@@ -0,0 +1,8 @@
+require 'billingbadger_api'
+# have to require all the files for Rails here
+files = [ 'customer', 'invoice', 'invoice_item', 'periodic_invoice', 'product', 'product_group', 'subscription' ]
+# +_+ #
+for file in files
+  # +_+ #
+  require "billingbadger/objects/#{file}"
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/billingbadger_api.rb'}"
+puts "Loading billingbadger_api gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_billingbadger_api.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+# -=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-
+# this test file will only work if you have a config file present.
+#
+# 1. set up a User account at the endpoint application
+# 2. create a new file config/billingbadger_api.yml
+# 3. paste the example file (in the doc/ folder) into it
+# 4. fill in the correct values
+# 5. test it!
+# -=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-
+
+class TestBillingbadgerApi < Test::Unit::TestCase
+  def setup
+  end
+  
+  def test_products_array
+    # Simple test that checks if we get an array of products back from the test environment.
+    ret = ::Billingbadger::Product.find(:all)
+    # gogo
+    #classes = [ "Product", "Subscription", "Customer", "Invoice", "InvoiceItem", "PeriodicInvoice", "ProductGroup" ]
+    classes = [ "Product", "Subscription", "Customer", "ProductGroup" ]
+    # +_+ #
+    for klazz in classes
+      k = eval("::Billingbadger::#{klazz}")
+      begin
+        ret = k.find(:all)
+      rescue => e
+        raise "Oops: klazz = #{klazz.to_s} error = #{e}"
+      end
+      assert_equal Array, ret.class
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/billingbadger_api'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: billingbadger_api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id003
+description: API gem for Billing Badger.
+email: 
+- commanderjohnson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/billingbadger_api.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_billingbadger_api.rb
+- test/test_helper.rb
+- docs/billingbadger_api.yml.example
+- lib/billingbadger/objects/product.rb
+- lib/billingbadger/objects/subscription.rb
+- lib/billingbadger/objects/customer.rb
+- lib/billingbadger/objects/invoice_item.rb
+- lib/billingbadger/objects/invoice.rb
+- lib/billingbadger/objects/periodic_invoice.rb
+- lib/billingbadger/objects/product_group.rb
+- lib/billingbadger/my_active_resource.rb
+- rails/init.rb
+- .gemtest
+homepage: http://github.com/cmdjohnson/billingbadger_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: billingbadger_api
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: API gem for Billing Badger.
+test_files: 
+- test/test_billingbadger_api.rb
+- test/test_helper.rb