btcjammer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77186d34b882bc759e332ed8e09454052e666a3a
+  data.tar.gz: ad9e1ba6a5316923890965a180a42ef11df5d1c1
+SHA512:
+  metadata.gz: f163f27066cc5aba1e73586c45160975e43e1711cbec70780f38b74ba428642eb3ecdc12a0bb45464e0ebf9bb595790c4e837ee68ac14840ce7fb4a86e0a0661
+  data.tar.gz: 2c17ad699ff8d1d2d1e65c30d74c69eddfc0cd6e3f17c00af7399f41b970da008b1aee3fe5b541eb93ae620444a4fb3e45af8b4b7c498ce217542c9d0d43986a

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/examples/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Cacciatore
+
+MIT License
+
+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,138 @@
+# btcjammer
+
+A Ruby interface to the BTCJam API.
+
+## Disclaimer
+
+Note, investing with BTCJam involves risk. Use this API at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'btcjammer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install btcjammer
+
+## Usage
+
+After installation and without further configuration you can use the following API methods:
+
+```ruby
+require 'btcjammer'
+
+# returns an array of currencies
+BTCJammer::Currencies.all
+
+# returns an array of employment types
+BTCJammer::EmploymentTypes.all
+
+# returns an array of national ID types
+BTCJammer::NationalIDTypes.all
+
+# returns an array of payment types
+BTCJammer::PaymentTypes.all
+
+# returns an array of automatic plan templates
+BTCJammer::AutomaticPlanTemplates.all
+```
+
+If you want to ask more interesting things, then you'll need a BCTJam account and need [to register an app](https://btcjam.com/oauth/applications) with BTCJam. Finally, grab your Application ID and Secret:
+
+```ruby
+require 'btcjammer'
+
+BTCJammer.configure do |config|
+	config.client_id     = "<YOUR APPLICATION ID>"
+	config.client_secret = "<YOUR SECRET>"
+end
+
+# returns an array of listings (not sure yet if it is paginated and if so how)
+BTCJammer::Listings.all
+
+# creates a new user (not very well tested currently)
+BTCJammer::Users.create "bilbo.baggins@shire.com", "Elevensies11"
+```
+
+Lastly, the following API methods require an authenticated user:
+
+```ruby
+require 'btcjammer'
+BTCJammer.configure do |config|
+	config.client_id     = "<YOUR APPLICATION ID>"
+	config.client_secret = "<YOUR SECRET>"
+	config.scopes				 = [:basic_profile, :extended_profile, :make_loan,
+													:identity_information, :address_information, :income_information,
+													:invest, :trade, :withdraw, :submit_documents, :manage_references]
+	config.redirect_uri  = "<YOUR REGISTERED CALLBACK URL>"
+end
+
+# send the user here to authorize
+auth = BTCJammer::OAuth.new
+
+url = auth.authorization_url
+
+# assuming you get a code back
+code = "<CODE YOU RECEIVED IN CALLBACK>"
+access_token = auth.get_access_token(code)
+
+# or if you have a saved token
+access_token = BTCJammer::OAuth.from_token token
+
+# retrieve the auth'd user's profile
+BTCJammer::Users.profile access_token.token
+
+# retrieve the auth'd user's payables
+BTCJammer::Users.payables access_token.token
+
+# retrieve the auth'd user's receivables
+BTCJammer::Users.receivables access_token.token
+
+# retrieve the auth'd user's credit checks
+BTCJammer::Users.credit_checks access_token.token
+
+# retrieve the auth'd user's addr checks
+BTCJammer::Users.addr_checks access_token.token
+
+# retrieve the auth'd user's identity checks
+BTCJammer::Users.identity_checks access_token.token
+
+# retrieve the auth'd user's open listings
+BTCJammer::Users.open_listings access_token.token
+
+# invest in a listing
+BTCJammer::User.invest access_token.token, {:listing_id => 123, :amount => 0.1}
+
+# create a new listing
+params = {
+  loan_purpose_id: 1,
+  currency_id: 2,
+  amount: 0.01,
+  term_days: 123,
+  payment_type_id: 3,
+  locale_id: 4,
+  title: 'A new listing',
+	description: 'Sweet!'
+}
+BTCJammer::Listings.create access_token.token, params
+```
+
+## Contributing
+
+If you would like ideas on what to work on, then please send me a line. There are plenty of opportunities to refactor code and extend the current functionality.
+
+1. Fork it ( https://github.com/cacciatc/btcjammer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write tests
+4. Run rubocop
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/btcjam'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/btcjammer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'btcjammer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'btcjammer'
+  spec.version       = BTCJammer::VERSION
+  spec.authors       = ['Chris Cacciatore']
+  spec.email         = ['chris.cacciatore@dullahansoft.com']
+  spec.summary       = 'A gem to wrap the BTCJam API.'
+  spec.description   = 'A simple wrapper for BTCJam API calls with support for user authenticated API calls.'
+  spec.homepage      = 'https://github.com/cacciatc/btcjammer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'vcr',	'~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'rubocop', '~> 0.34'
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'oauth2', '~> 1.0'
+end

data/lib/btcjammer.rb

@@ -0,0 +1,74 @@
+require 'ostruct'
+require 'oauth2'
+
+require_relative 'btcjammer/version'
+require_relative 'btcjammer/currencies'
+require_relative 'btcjammer/payment_types'
+require_relative 'btcjammer/automatic_plan_templates'
+require_relative 'btcjammer/employment_statuses'
+require_relative 'btcjammer/national_id_types'
+require_relative 'btcjammer/listings'
+require_relative 'btcjammer/users'
+require_relative 'btcjammer/terms'
+require_relative 'btcjammer/submit_documents'
+require_relative 'btcjammer/automatic_plans'
+
+# Contains all the BTCJam API magic
+module BTCJammer
+  API_URL = 'https://btcjam.com/api/v1'
+  API_PUBLIC_URL = 'https://btcjam.com'
+
+  # Holds info for oauth config including BTCJam scopes
+  module Configuration
+    attr_accessor :client_id, :client_secret, :scopes, :redirect_uri
+
+    def configure
+      yield self
+    end
+  end
+
+  # Helper methods around OAuth2
+  class OAuth
+    include OAuth2
+    attr_accessor :client
+    def initialize
+      @client = Client.new(BTCJam.client_id, BTCJam.client_secret,
+                           site: API_PUBLIC_URL)
+    end
+
+    def authorization_url
+      @client.auth_code.authorize_url(redirect_uri: BTCJam.redirect_uri,
+                                      scope: BTCJam.scopes.join(' '))
+    end
+
+    def get_access_token(code)
+      @client.auth_code.get_token(code, redirect_uri: BTCJam.redirect_uri)
+    end
+
+    def self.from_token(token)
+      auth = OAuth.new
+      OAuth2::AccessToken.new(auth.client, token)
+    end
+  end
+
+  def self.get_client(access_token)
+    id     = ENV['BTCJAM_CLIENT_ID']
+    secret = ENV['BTCJAM_CLIENT_SECRET']
+    client = OAuth2::Client.new id, secret, site: 'https://btcjam.com'
+
+    OAuth2::AccessToken.new client, access_token
+  end
+
+  def self.api_call(access_token, symbol, type)
+    token = get_client access_token
+    response = token.get("#{API_URL}/#{symbol}.json")
+
+    if type == :object
+      OpenStruct.new JSON.parse(response.body)
+    elsif type == :array
+      JSON.parse(response.body).collect { |i| OpenStruct.new i }
+    end
+  end
+
+  extend Configuration
+end

data/lib/btcjammer/automatic_plan_templates.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class AutomaticPlanTemplates
+    def self.all
+      response = Faraday.get("#{API_PUBLIC_URL}/automatic_plan_templates.json")
+      JSON.parse(response.body).collect { |t| OpenStruct.new t }
+    end
+  end
+end

data/lib/btcjammer/automatic_plans.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class AutomaticPlans
+    def self.create(access_token, params)
+      token    = BTCJammer.get_client access_token
+      response = token.post("#{API_URL}/automatic_plans.json", body: { automatic_plan: params.to_json })
+
+      result = OpenStruct.new JSON.parse(response.body)
+      OpenStruct.new(result.automatic_plan)
+    end
+
+    def self.all(access_token)
+      token = BTCJammer.get_client access_token
+      response = token.get("#{API_URL}/automatic_plans.json")
+
+      result = OpenStruct.new JSON.parse(response.body)
+      result.collect { |r| OpenStruct.new r }
+    end
+  end
+end

data/lib/btcjammer/currencies.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class Currencies
+    def self.all
+      response = Faraday.get("#{API_PUBLIC_URL}/currencies.json")
+      JSON.parse(response.body).collect { |c| OpenStruct.new c }
+    end
+  end
+end

data/lib/btcjammer/employment_statuses.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class EmploymentStatuses
+    def self.all
+      response = Faraday.get("#{API_PUBLIC_URL}/employment_statuses.json")
+      JSON.parse(response.body).collect { |t| OpenStruct.new t }
+    end
+  end
+end

data/lib/btcjammer/listings.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class Listings
+    def self.all
+      url = "#{API_URL}/"
+      url += "listings.json?appid=#{BTCJammer.client_id}&"
+      url += "secret=#{BTCJammer.client_secret}"
+
+      response = Faraday.get(url)
+
+      JSON.parse(response.body).collect do |c|
+        listing = OpenStruct.new c['listing']
+        listing.user = OpenStruct.new listing.user
+
+        listing
+      end
+    end
+
+    def self.create(access_token, params)
+      token    = BTCJammer.get_client access_token
+      response = token.post("#{API_URL}/listings.json", body: { listing: params.to_json })
+
+      result = OpenStruct.new JSON.parse(response.body)
+      OpenStruct.new(result.listing)
+    end
+
+    def self.create_lead(access_token, params)
+      token = BTCJammer.get_client access_token
+      response = token.post("#{API_URL}/lead_listings.json", body: { lead_listing: params.to_json })
+
+      result = OpenStruct.new JSON.parse(response.body)
+      OpenStruct.new(result.lead_listing)
+    end
+  end
+end

data/lib/btcjammer/national_id_types.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class NationalIDTypes
+    def self.all
+      response = Faraday.get("#{API_PUBLIC_URL}/nationalid_types.json")
+      JSON.parse(response.body).collect { |t| OpenStruct.new t }
+    end
+  end
+end

data/lib/btcjammer/payment_types.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module BTCJammer
+  # https://btcjam.com/faq/api
+  class PaymentTypes
+    def self.all
+      response = Faraday.get("#{API_PUBLIC_URL}/payment_types.json")
+      JSON.parse(response.body).collect { |t| OpenStruct.new t }
+    end
+  end
+end