bpruby 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,108 @@
+# Bpruby
+
+This Gem is for making easy Api-Calls to the Bitpay.com Payment Api.
+It currently supports Creating an Invoice and getting the Status of an Invoice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bpruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bpruby
+
+## Usage
+
+
+There are two methods available :
+
+#createInvoice(apikey,price,orderId,posData,options={})
+
+#Example Call : Bpruby::Bplib.createInvoice(
+	'XXXXAPIKEYHERE',
+	15.40,
+	'333',
+	'230928307203',
+	:transactionSpeed => 'high',
+	:itemDesc =>'Test',
+	:currency => 'USD',
+	:buyerEmail =>'test@bitpay.com',
+	:buyerAddress1 =>'On the',
+	:buyerAddress2 =>'Teststreet')
+
+Required Parameters : 
+
+- Api-Key : Obtainable in your Bitpay Merchant Account
+- Price : This is the amount that is required to be collected from the
+buyer. Note, if this is specified in a currency other than BTC,
+the price will be converted into BTC at market exchange
+rates to determine the amount collected from the buyer.
+- orderID : Used to display an orderID to the buyer. In the account
+summary view, this value is used to identify a ledger entry if
+present.
+- posData : This content of this field is included in status updates or
+requests to get an invoice. It is intended to be used by
+the merchant to uniquely identify an order associated with
+an invoice in their system. Aside from that, Bit-Pay does
+not use the data in this field. The data in this field can be
+anything that is meaningful to the merchant
+
+-Parameters that are required but are already set to a default :
+
+ -:currency => BTC ,can be overwritten if needed. Currently BTC and USD supported. Get more infos from Bitpay.
+
+-Optional Parameters : 
+
+ -:itemDesc ,:itemCode, :notificationEmail, :notificationURL, :redirectURL,
+ -:currency, :physical, :fullNotifications, :transactionSpeed, :buyerName, 
+ -:buyerAddress1, :buyerAddress2, :buyerCity, :buyerState, :buyerZip, :buyerEmail, :buyerPhone
+
+-The Method returns a Json-Object with the following Information :
+
+ -id  : The unique id of the invoice.
+ -url : An https URL where the invoice can be viewed.
+ -posData : A data field provided by the merchant and designed to be used by the merchant to
+ -correlate : the invoice with an order or other object in their system.
+ -status  : The current invoice status. The possible states are described earlier in this document.
+ -btcPrice : The amount of bitcoins being requested for payment of this invoice (same as the price if
+             the merchant set the price in BTC).
+ -price  : The price set by the merchant (in terms of the provided currency).
+ -currency : The 3 letter currency code in which the invoice was priced.
+ -invoiceTime : The time the invoice was created in milliseconds since midnight January 1, 1970.
+ -expirationTime : The time at which the invoice expires and no further payment will be accepted (in
+ -milliseconds : since midnight January 1, 1970). Currently, all invoices are valid for 15
+                 minutes.
+ -currentTime : The current time on the Bit-Pay.com system (by subtracting the current time from the
+ -expiration  : time, the amount of time remaining for payment can be determined).
+
+More Information about Parameters and calls : https://bitpay.com/help-api
+
+
+
+#getInvoice(apikey,invoiceID)
+
+#example call : Bpruby::Bplib.getInvoice('XXXXXXXXXXYOURAPIKEYHERE','T11zE6Xmoz4rK1qq5ktalduPTUO9C9V9NN-BBEpv58o=')
+
+To get the current state of an invoice, an http GET request can be sent to https://bitpay.com/api/invoice/
+<id> where the id is the invoice id provided when the invoice was created. The format of the response is
+exactly the same as that which is returned when creating an invoice.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## About me :
+
+I am a Ruby Newbie and i like to try ideas. If i have fundamental flaws or when i'm missing best practices please tell me , i am eager to learn !
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/bpruby

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bpruby'
+
+puts Bpruby::Bplib.createInvoice('JRcbOrlCYNhMFDfYygX3NSHypUibMZzC59v15P95AQg',0.14,'45','85',:transactionSpeed => 'high',:itemDesc =>'Test',:currency => 'USD',:buyerEmail =>'gekuesst@googlemail.com',:buyerAddress1 =>'Hinterm',:buyerAddress2 =>'Testheim')
+
+puts Bpruby::Bplib.getInvoice('JRcbOrlCYNhMFDfYygX3NSHypUibMZzC59v15P95AQg','T11zE6Xmoz4rK1qq5ktalduPTUO9C9V9NN-BBEpv58o=')

data/bpruby.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bpruby/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Phantastisch"]
+  gem.email         = ["gekuesst@googlemail.com"]
+  gem.description   = %q{Bitpay for Ruby}
+  gem.summary       = %q{Easy Bitpay-Api Calls for Ruby}
+  gem.homepage      = "https://github.com/phanaster/BP-for-Ruby"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bpruby"
+  gem.require_paths = ["lib"]
+  gem.version       = Bpruby::VERSION
+  gem.add_dependency "rest-client"
+end

data/lib/bpruby.rb

@@ -0,0 +1,86 @@
+require "bpruby/version"
+
+
+module Bpruby
+ class Bplib
+  require 'rest-client'
+   
+  =begin
+   Required Parameters : 
+
+- Api-Key : Obtainable in your Bitpay Merchant Account
+- Price : This is the amount that is required to be collected from the
+buyer. Note, if this is specified in a currency other than BTC,
+the price will be converted into BTC at market exchange
+rates to determine the amount collected from the buyer.
+- orderID : Used to display an orderID to the buyer. In the account
+summary view, this value is used to identify a ledger entry if
+present.
+- posData : This content of this field is included in status updates or
+requests to get an invoice. It is intended to be used by
+the merchant to uniquely identify an order associated with
+an invoice in their system. Aside from that, Bit-Pay does
+not use the data in this field. The data in this field can be
+anything that is meaningful to the merchant
+
+Parameters that are required but are already set to a default :
+
+:currency => BTC ,can be overwritten if needed. Currently BTC and USD supported. Get more infos from Bitpay.
+
+Optional Parameters : 
+
+:itemDesc ,:itemCode, :notificationEmail, :notificationURL, :redirectURL,
+:currency, :physical, :fullNotifications, :transactionSpeed, :buyerName, 
+:buyerAddress1, :buyerAddress2, :buyerCity, :buyerState, :buyerZip, :buyerEmail, :buyerPhone
+
+The Method returns a Json-Object with the following Information :
+
+id  : The unique id of the invoice.
+url : An https URL where the invoice can be viewed.
+posData : A data field provided by the merchant and designed to be used by the merchant to
+correlate : the invoice with an order or other object in their system.
+status  : The current invoice status. The possible states are described earlier in this document.
+btcPrice : The amount of bitcoins being requested for payment of this invoice (same as the price if
+the merchant set the price in BTC).
+price  : The price set by the merchant (in terms of the provided currency).
+currency : The 3 letter currency code in which the invoice was priced.
+invoiceTime : The time the invoice was created in milliseconds since midnight January 1, 1970.
+expirationTime : The time at which the invoice expires and no further payment will be accepted (in
+milliseconds : since midnight January 1, 1970). Currently, all invoices are valid for 15
+minutes.
+currentTime : The current time on the Bit-Pay.com system (by subtracting the current time from the
+expiration  : time, the amount of time remaining for payment can be determined).
+
+More Information about Parameters and calls : https://bitpay.com/help-api
+
+  =end			 
+				 
+  def self.createInvoice(apikey,price,orderId,posData,options={})
+     
+	 defaultoptions ||= {                
+	            :currency => 'BTC' ,  
+				:physical => 'true', 
+				:fullNotifications => 'true', 
+				:transactionSpeed => 'low', 
+                 }
+				 
+	options = defaultoptions.merge(options)
+    options[:price] = price
+	options[:orderId]= orderId
+	options[:posData]= posData
+	 
+	 
+		
+				
+     response = RestClient.post "https://#{apikey}:@bitpay.com/api/invoice", options, :content_type => :json, :accept => :json
+     return response 
+   end
+   
+     
+	  def self.getInvoice(apikey,invoiceId)
+    
+       response = RestClient.get "http://#{apikey}:@bitpay.com/api/invoice/#{invoiceId}", :content_type => :json, :accept => :json
+	  return response
+	  end
+  end
+end

data/lib/bpruby/bplib.rb

@@ -0,0 +1,49 @@
+module BPRUBY
+ class BPLIB
+   require 'rest-client'
+  
+    
+    
+				 
+				 
+  def bpCreateInvoice(price,orderid,posData,options={})
+    
+	
+	@options ||= {                
+	            'currency' => 'BTC' ,
+            	'notificationEmail' => '',
+				'notificationURL' => '', 
+				'redirectURL' => '',  
+				'physical' => 'true', 
+				'fullNotifications' => 'true', 
+				'transactionSpeed' => 'low', 
+                 }
+	
+	
+	
+	options = @options.merge(options)
+    options[:price] = price
+	options[:orderId]= orderid
+	options[:posData]= posData
+	 
+	 
+	postOptions = ['orderID', 'itemDesc', 'itemCode', 'notificationEmail', 'notificationURL', 'redirectURL', 
+		'posData', 'price', 'currency', 'physical', 'fullNotifications', 'transactionSpeed', 'buyerName', 
+		'buyerAddress1', 'buyerAddress2', 'buyerCity', 'buyerState', 'buyerZip', 'buyerEmail', 'buyerPhone']
+		
+		postOptions.each_with_index do |opt,index|
+		 if options.include(opt[index])
+		    postdata[index] = options[index]			
+		 end
+        end
+		
+		
+		
+    postdata = {}
+				
+				
+    response = RestClient.post "https://JRcbOrlCYNhMFDfYygX3NSHypUibMZzC59v15P95AQg:@bitpay.com/api/invoice", postdata, :content_type => :json, :accept => :json
+    return response 
+  end
+ end
+end

data/lib/bpruby/version.rb

@@ -0,0 +1,3 @@
+module Bpruby
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: bpruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Phantastisch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bitpay for Ruby
+email:
+- gekuesst@googlemail.com
+executables:
+- bpruby
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/bpruby
+- bpruby.gemspec
+- lib/bpruby.rb
+- lib/bpruby/bplib.rb
+- lib/bpruby/version.rb
+homepage: https://github.com/phanaster/BP-for-Ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy Bitpay-Api Calls for Ruby
+test_files: []