billplz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 396dcae8959f96089fb7475ce462ba8a48d24259
+  data.tar.gz: 430be52e924f8e7d167b4258de0967bea8ba0a01
+SHA512:
+  metadata.gz: e02c0c88a730d1f9c311831e77c7706a5231b23e37c75335efab7388a3bca22fa3e6930f8bac98ffd561c5da5d66a5c281d3e24bf98698e93158c60da5ccd156
+  data.tar.gz: db53f6c06997177a343e0722c342f59e495607ca8d687a7dadfcad719eb2d0cb167f52c1b66be19c293aa72806139147567e320dbd81710f560e5583c9add265

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sy4mil@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Syamil MJ
+
+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,114 @@
+# Billplz
+
+[![Circle CI](https://circleci.com/gh/syamilmj/billplz.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/syamilmj/billplz)
+
+An abstraction library to interface with the [Billplz API](https://www.billplz.com/api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'billplz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install billplz
+
+## Usage
+
+**Configuration**
+
+You may store your Billplz configuration during runtime:
+
+```ruby
+# config/initializers/billplz.rb
+Billplz.configure do |config|
+  config.api_key      = ENV['BILLPLZ_API_KEY']
+end
+```
+
+All the options above can be overridden manually:
+
+```ruby
+Billplz.configuration.api_key      = 'your-api-key'
+```
+
+Or, as a hash:
+
+```ruby
+Billplz.configuration = { api_key: 'your-api-key' }
+```
+
+**Collection**
+
+Create a new collection:
+
+```ruby
+collection = Billplz::Collection.new({ title: 'My awesome collection' })
+collection.create
+```
+
+**Bill**
+
+Create a new bill:
+
+```ruby
+bill = Billplz::Bill.new({ collection_id: VALID_COLLECTION_ID, ... })
+bill.create
+```
+
+Get a bill:
+
+```ruby
+bill = Billplz::Bill.new({ bill_id: 'abc123'})
+bill.get
+```
+
+Delete a bill:
+
+```ruby
+bill = Billplz::Bill.new({ bill_id: 'abc123'})
+bill.delete
+```
+
+**Response**
+
+Standard Net::HTTP response will be returned by all of the above methods. However, the gem packed a few helper methods to make your life easier:
+
+1. `#success?`
+
+You can check for a successfull request using `success?`, example:
+
+```
+bill.success?
+```
+
+2. `#parsed_json`
+
+This is a convenient helper to parse the JSON response from the API, example:
+
+```ruby
+bill_id = bill.parsed_json['id']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Running `rake test:remote` will run tests that performs actual communication with the API server. Proceed with caution.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/syamilmj/billplz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Run the unit test suite"
+task :default => 'test:unit'
+task :test => 'test:unit'
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems -w'
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote) do |t|
+    t.pattern = 'test/remote/**/*_test.rb'
+    t.ruby_opts << '-rubygems -w'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end
+
+desc "Tag and release"
+task :tag_release do
+  system "git tag 'v#{Billplz::VERSION}'"
+  system "git push --tags"
+end

data/billplz.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'billplz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "billplz"
+  spec.version       = Billplz::VERSION
+
+  spec.summary       = 'Abstraction library to interface with the Billplz API'
+  spec.homepage      = 'http://tideee.com'
+  spec.license       = 'MIT'
+
+  spec.author        = 'Syamil MJ'
+  spec.email         = 'syamilmj@tideee.com'
+  spec.homepage      = 'http://tideee.com/'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "mocha"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "billplz"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circleci.yml

@@ -0,0 +1,7 @@
+ruby:
+  version:
+    2.3.0
+environment:
+  CIRCLE_ENV: test
+dependencies:
+  pre: gem install bundler -v 1.11.2

data/lib/billplz/bill.rb

@@ -0,0 +1,22 @@
+module Billplz
+  class Bill < Model
+    self.api_url = 'https://www.billplz.com/api/v2/bills'
+
+    def create
+      requires!(@payload, :collection_id, :email, :name, :amount, :callback_url)
+      request(:post, @payload)
+    end
+
+    def get
+      requires!(@payload, :bill_id)
+      @api_url = "#{@api_url}/#{@payload[:bill_id]}"
+      request(:get, nil)
+    end
+
+    def delete
+      requires!(@payload, :bill_id)
+      @api_url = "#{@api_url}/#{@payload[:bill_id]}"
+      request(:delete, nil)
+    end
+  end
+end

data/lib/billplz/collection.rb

@@ -0,0 +1,10 @@
+module Billplz
+  class Collection < Model
+    self.api_url = 'https://www.billplz.com/api/v2/collections'
+
+    def create
+      requires!(@payload, :title)
+      request(:post, @payload)
+    end
+  end
+end

data/lib/billplz/configuration.rb

@@ -0,0 +1,39 @@
+module Billplz
+  class Configuration
+    attr_accessor :api_key, :http_timeout, :mode
+
+    def initialize(options={})
+      @http_timeout = 30
+      @mode         = 'live'
+    end
+
+    def options
+      hash = Hash.new
+      %w[api_key http_timeout mode].map{|key| hash[key.to_sym] = send(key) }
+      hash
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(args)
+    @configuration ||= Configuration.new
+    args.each do |arg|
+      @configuration.send("#{arg.first}=", arg.last)
+    end
+  end
+
+  def self.options
+    @configuration.options
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset
+    @configuration = nil
+  end
+end

data/lib/billplz/model.rb

@@ -0,0 +1,81 @@
+module Billplz
+  class Model
+    attr_writer :endpoint
+    attr_accessor :payload
+    attr_accessor :response
+
+    def initialize(payload={})
+      @api_url  = self.api_url
+      @payload  = payload
+    end
+
+    def request(method, body)
+      headers = {
+        "Authorization" => "Basic " + Base64.encode64(Billplz.configuration.api_key + ":").strip,
+        "Content-Type"  => "application/json",
+        "Accept"        => "application/json"
+      }
+
+      @response = case method
+      when :get
+        raise ArgumentError, "GET requests do not support a request body" if body
+        http.get(endpoint.request_uri, headers)
+      when :post
+        http.post(endpoint.request_uri, body.to_json, headers)
+      when :put
+        http.put(endpoint.request_uri, body.to_json, headers)
+      when :patch
+        http.patch(endpoint.request_uri, body, headers)
+      when :delete
+        raise ArgumentError, "DELETE requests do not support a request body" if body
+        http.delete(endpoint.request_uri, headers)
+      else
+        raise ArgumentError, "Unsupported request method #{method.to_s.upcase}"
+      end
+
+      @response
+    end
+
+    class << self
+      attr_accessor :api_url
+    end
+
+    def api_url
+      self.class.api_url
+    end
+
+    def endpoint
+      URI.parse(@api_url)
+    end
+
+    def success?
+      @response.is_a?(Net::HTTPOK)
+    end
+
+    def parsed_json
+      JSON.parse(@response.body)
+    end
+
+    private
+
+    def http
+      http = Net::HTTP.new(endpoint.host, endpoint.port)
+      http.use_ssl = true
+      # http.set_debug_output($stdout)
+      http
+    end
+
+    def requires!(hash, *params)
+      params.each do |param|
+        if param.is_a?(Array)
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+          valid_options = param[1..-1]
+          raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(:words_connector => 'or')}") unless valid_options.include?(hash[param.first])
+        else
+          raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+        end
+      end
+    end
+  end
+end

data/lib/billplz/version.rb

@@ -0,0 +1,3 @@
+module Billplz
+  VERSION = "0.1.0"
+end

data/lib/billplz.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'base64'
+
+require "billplz/version"
+require "billplz/configuration"
+require "billplz/model"
+require "billplz/bill"
+require "billplz/collection"
+
+module Billplz
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: billplz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syamil MJ
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !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: test-unit
+  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: mocha
+  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'
+description: 
+email: syamilmj@tideee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- billplz.gemspec
+- bin/console
+- bin/setup
+- circleci.yml
+- lib/billplz.rb
+- lib/billplz/bill.rb
+- lib/billplz/collection.rb
+- lib/billplz/configuration.rb
+- lib/billplz/model.rb
+- lib/billplz/version.rb
+homepage: http://tideee.com/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Abstraction library to interface with the Billplz API
+test_files: []