killbill-client 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,18 @@
+[![Build Status](https://travis-ci.org/killbill/killbill-client-ruby.png)](https://travis-ci.org/killbill/killbill-client-ruby)
+[![Code Climate](https://codeclimate.com/github/killbill/killbill-client-ruby.png)](https://codeclimate.com/github/killbill/killbill-client-ruby)
+
+killbill-client-ruby
+====================
+
+Kill Bill ruby library.
+
+Tests
+-----
+
+To run the integration tests:
+
+```
+rake test:remote:spec
+```
+
+You need to set in spec/spec_helper.rb the url of your instance, e.g. `KillBillClient.url = 'http://127.0.0.1:8080'`.

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+
+# Install tasks to build and release the plugin
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+# Install test tasks
+require 'rspec/core/rake_task'
+namespace :test do
+  desc 'Run RSpec tests'
+  RSpec::Core::RakeTask.new do |task|
+    task.name = 'spec'
+    task.pattern = './spec/*/*_spec.rb'
+  end
+
+  namespace :remote do
+    desc 'Run RSpec remote tests'
+    RSpec::Core::RakeTask.new do |task|
+      task.name = 'spec'
+      task.pattern = './spec/*/remote/*_spec.rb'
+    end
+  end
+end
+
+# Run tests by default
+task :default => 'test:spec'

data/killbill_client.gemspec

@@ -0,0 +1,44 @@
+#
+# Copyright 2010-2013 Ning, Inc.
+#
+# Ning licenses this file to you under the Apache License, version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at:
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'killbill_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'killbill-client'
+  s.version     = KillBillClient::Version.to_s
+  s.summary     = 'Kill Bill client library.'
+  s.description = 'An API client library for Kill Bill.'
+
+  s.required_ruby_version = '>= 1.8.6'
+
+  s.license = 'Apache License (2.0)'
+
+  s.author   = 'Killbill core team'
+  s.email    = 'killbilling-users@googlegroups.com'
+  s.homepage = 'http://www.killbilling.org'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rdoc_options << '--exclude' << '.'
+
+  s.add_development_dependency 'rake', '>= 10.0.0'
+  s.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/lib/killbill_client.rb

@@ -0,0 +1,93 @@
+#
+# Copyright 2011-2013 Ning, Inc.
+#
+# Ning licenses this file to you under the Apache License, version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at:
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# KillBillClient is a Ruby client for Kill Bill's REST API.
+module KillBillClient
+  # The exception class from which all KillBill exceptions inherit.
+  class Error < StandardError
+    def set_message(message)
+      @message = message
+    end
+
+    # @return [String]
+    def to_s
+      defined? @message and @message or super
+    end
+  end
+
+  # This exception is raised if KillBill has not been configured.
+  class ConfigurationError < Error
+  end
+
+  class << self
+    # @return [String] A host.
+    def url
+      defined? @url and @url or raise(
+          ConfigurationError, 'KillBillClient.url not configured'
+      )
+    end
+
+    attr_writer :url
+
+    # Tenant key/password. Optional.
+    attr_accessor :api_key
+    attr_accessor :api_secret
+
+    # @return [String, nil] A default currency.
+    def default_currency
+      return @default_currency if defined? @default_currency
+      @default_currency = 'USD'
+    end
+
+    attr_writer :default_currency
+
+    # Assigns a logger to log requests/responses and more.
+    #
+    # @return [Logger, nil]
+    # @example
+    #   require 'logger'
+    #   KillBill.logger = Logger.new STDOUT
+    # @example Rails applications automatically log to the Rails log:
+    #   KillBill.logger = Rails.logger
+    # @example Turn off logging entirely:
+    #   KillBill.logger = nil # Or KillBill.logger = Logger.new nil
+    attr_accessor :logger
+
+    # Convenience logging method includes a Logger#progname dynamically.
+    # @return [true, nil]
+    def log(level, message)
+      logger.send(level, name) { message }
+    end
+
+    if RUBY_VERSION <= '1.9.0'
+      def const_defined?(sym, inherit = false)
+        raise ArgumentError, 'inherit must be false' if inherit
+        super sym
+      end
+
+      def const_get(sym, inherit = false)
+        raise ArgumentError, 'inherit must be false' if inherit
+        super sym
+      end
+    end
+  end
+
+  require 'killbill_client/api/api'
+  require 'killbill_client/models/models'
+  require 'killbill_client/utils'
+  require 'killbill_client/version'
+end
+
+require 'rails/killbill_client' if defined? Rails::Railtie

data/lib/killbill_client/api/api.rb

@@ -0,0 +1,85 @@
+module KillBillClient
+  # The API class handles all requests to the Kill Bill API. While most of its
+  # functionality is leveraged by the Resource class, it can be used directly,
+  # as well.
+  #
+  # Requests are made with methods named after the four main HTTP verbs
+  # recognized by the Kill Bill API.
+  #
+  # @example
+  #   KillBillClient::API.get 'accounts'             # => #<Net::HTTPOK ...>
+  #   KillBillClient::API.post 'accounts', json_body  # => #<Net::HTTPCreated ...>
+  #   KillBillClient::API.put 'accounts/1', json_body # => #<Net::HTTPOK ...>
+  #   KillBillClient::API.delete 'accounts/1'        # => #<Net::HTTPNoContent ...>
+  class API
+    require 'killbill_client/api/errors'
+
+    class << self
+      # Additional HTTP headers sent with each API call
+      # @return [Hash{String => String}]
+      def headers
+        @headers ||= {'Accept' => accept, 'User-Agent' => user_agent}
+      end
+
+      # @return [String, nil] Accept-Language header value
+      def accept_language
+        headers['Accept-Language']
+      end
+
+      # @param [String] language Accept-Language header value
+      def accept_language=(language)
+        headers['Accept-Language'] = language
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def head(uri, params = {}, options = {})
+        request :head, uri, {:params => params}.merge(options)
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def get(uri, params = {}, options = {})
+        request :get, uri, {:params => params}.merge(options)
+      end
+
+      # @return [Net::HTTPCreated, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def post(uri, body = nil, params = {}, options = {})
+        request :post, uri, {:body => body.to_s}.merge({:params => params}).merge(options)
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def put(uri, body = nil, params = {}, options = {})
+        request :put, uri, {:body => body.to_s}.merge({:params => params}).merge(options)
+      end
+
+      # @return [Net::HTTPNoContent, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def delete(uri, params = {}, options = {})
+        request :delete, uri, {:params => params}.merge(options)
+      end
+
+      # @return [URI::Generic]
+      def base_uri
+        URI.parse(KillBillClient.url)
+      end
+
+      # @return [String]
+      def user_agent
+        "killbill/#{Version}; #{RUBY_DESCRIPTION}"
+      end
+
+      private
+
+      def accept
+        'application/json'
+      end
+
+      alias content_type accept
+    end
+  end
+end
+
+require 'killbill_client/api/net_http_adapter'

data/lib/killbill_client/api/errors.rb

@@ -0,0 +1,175 @@
+require 'cgi'
+
+module KillBillClient
+  class API
+    # The superclass to all errors that occur when making an API request.
+    class ResponseError < Error
+      attr_reader :request
+      attr_reader :response
+
+      def initialize(request, response)
+        @request, @response = request, response
+      end
+
+      def code
+        response.code.to_i if response and response.code
+      end
+
+      def to_s
+        if description
+          return CGI.unescapeHTML description
+        end
+
+        return super unless code
+        '%d %s (%s %s)' % [
+            code, http_error, request.method, API.base_uri + request.path
+        ]
+      end
+
+      private
+
+      def description
+        @response.body.strip if @response.body
+      end
+
+      def http_error
+        Utils.demodulize self.class.name.gsub(/([a-z])([A-Z])/, '\1 \2')
+      end
+    end
+
+    # === 3xx Redirection
+    #
+    # Not an error, per se, but should result in one in the normal course of
+    # API interaction.
+    class Redirection < ResponseError
+    end
+
+    # === 304 Not Modified
+    #
+    # Raised when a request is made with an ETag.
+    class NotModified < ResponseError
+    end
+
+    # === 4xx Client Error
+    #
+    # The superclass to all client errors (responses with status code 4xx).
+    class ClientError < ResponseError
+    end
+
+    # === 400 Bad Request
+    #
+    # The request was invalid or could not be understood by the server.
+    # Resubmitting the request will likely result in the same error.
+    class BadRequest < ClientError
+    end
+
+    # === 401 Unauthorized
+    #
+    # The API key is missing or invalid for the given request.
+    class Unauthorized < ClientError
+    end
+
+    # === 403 Forbidden
+    #
+    # The login is attempting to perform an action it does not have privileges
+    # to access. The login credentials are correct.
+    class Forbidden < ClientError
+    end
+
+    # === 404 Not Found
+    #
+    # The resource was not found. This may be returned if the given account
+    # code or subscription plan does not exist. The response body will explain
+    # which resource was not found.
+    class NotFound < ClientError
+    end
+
+    # === 405 Method Not Allowed
+    #
+    # A method was attempted where it is not allowed.
+    #
+    # If this is raised, there may be a bug with the client library or with
+    # the server. Please contact skillbilling-users@googlegroups.com or
+    # {file a bug}[https://github.com/killbill/killbill-client-ruby/issues].
+    class MethodNotAllowed < ClientError
+    end
+
+    # === 406 Not Acceptable
+    #
+    # The request content type was not acceptable.
+    #
+    # If this is raised, there may be a bug with the client library or with
+    # the server. Please contact killbilling-users@googlegroups.com or
+    # {file a bug}[https://github.com/killbill/killbill-client-ruby/issues].
+    class NotAcceptable < ClientError
+    end
+
+    # === 415 Unsupported Media Type
+    #
+    # The request body was not recognized as XML.
+    #
+    # If this is raised, there may be a bug with the client library or with
+    # the server. Please contact killbilling-users@googlegroups.com or
+    # {file a bug}[https://github.com/killbill/killbill-client-ruby/issues].
+    class UnsupportedMediaType < ClientError
+    end
+
+    # === 422 Unprocessable Entity
+    #
+    # Could not process a POST or PUT request because the request is invalid.
+    # See the response body for more details.
+    class UnprocessableEntity < ClientError
+    end
+
+    # === 5xx Server Error
+    #
+    # The superclass to all server errors (responses with status code 5xx).
+    class ServerError < ResponseError
+    end
+
+    # === 500 Internal Server Error
+    #
+    # The server encountered an error while processing your request and failed.
+    class InternalServerError < ServerError
+    end
+
+    # === 502 Gateway Error
+    #
+    # The load balancer or web server had trouble connecting to Killbill.
+    # Please try the request again.
+    class GatewayError < ServerError
+    end
+
+    # === 503 Service Unavailable
+    #
+    # The service is temporarily unavailable. Please try the request again.
+    class ServiceUnavailable < ServerError
+    end
+
+    # Error mapping by status code.
+    ERRORS = Hash.new { |hash, code|
+      unless hash.key? code
+        case code
+          when 400...500 then
+            ClientError
+          when 500...600 then
+            ServerError
+          else
+            ResponseError
+        end
+      end
+    }.update(
+        304 => NotModified,
+        400 => BadRequest,
+        401 => Unauthorized,
+        403 => Forbidden,
+        404 => NotFound,
+        406 => NotAcceptable,
+        415 => UnsupportedMediaType,
+        422 => UnprocessableEntity,
+        500 => InternalServerError,
+        502 => GatewayError,
+        503 => ServiceUnavailable
+    ).freeze
+  end
+end