localbitcoins 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 328de725d7d4599c74ab908fd9ad80060ffbe506
+  data.tar.gz: a2a025486733fb792f1451300e1881f8fbc72d76
+SHA512:
+  metadata.gz: 12d1c22f51687f49306df32c0968999a9462981347a9b630e4f6cad74f69943ce0f8216e9ed2d7c5178cfe746bc48e201b537f42f17e7b17e1e694f93e204ed4
+  data.tar.gz: 969062b433e58717379b54bbaac91652fc27b45327d4ef8f9f157632b35df77edb710e97dfce622f787914012335a85798db8fc0dda93d4e6c9ffb079e058b1d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Vim temp files
+*~
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,102 @@
+# LocalBitcoins API Client
+
+This gem provides a simple, extensible Ruby client to access the [LocalBitcoins API](https://localbitcoins.com/api-docs/).
+
+## Installation
+
+Install the gem:
+```
+gem install localbitcoins
+```
+
+Or include it in your Gemfile:
+```
+gem 'openlibrary'
+```
+
+## Setting Up Your OAuth Client 
+
+First, you need to [register your application](https://localbitcoins.com/accounts/api/) with LocalBitcoins to get your API keys. You will get a Client ID and a Client Secret, which you will use to get your OAuth access token. An OAuth access token is required for all requests to the LocalBitcoins API. 
+
+There are a number of ways to implement OAuth, and it is largely left up to you to decide how to do it. If you've never used OAuth before, reading [this tutorial](http://aaronparecki.com/articles/2012/07/29/1/oauth2-simplified) is a good place to start!
+
+Once you have your token, you can set up your client with the following code:
+
+``` ruby
+# long version
+client = LocalBitcoins::Client.new(oauth_token: 'OAUTH_TOKEN')
+# short version
+client = LocalBitcoins.new(oauth_token: 'OAUTH_TOKEN')
+```
+
+### Global Configuration
+
+To make things easier, you can define your client credentials at a global level:
+
+``` ruby
+# Set the configuration
+LocalBitcoins.configure(
+  client_id: 'ID',
+  client_secret: 'SECRET'
+)
+
+# Get the configuration
+LocalBitcoins.configuration # => { client_id => 'ID', client_secret => 'SECRET' }
+
+# Reset the configuration
+LocalBitcoins.reset_configuration
+```
+
+If you're using Rails, you can set the configuration with an initializer file in `config/initializers`.
+
+REMEMBER: Keep your client credentials secret! Do not include them in git repos, or place them anywhere that users can see them. If you suspect that your credentials have been accessed by someone else, immediately reset your client secret from your LocalBitcoins Apps Dashboard.
+
+There are several ways to solve the problem of keeping your credentials secret. For Rails apps, I like to store them as environment variables and access them with [figaro](https://github.com/laserlemon/figaro).
+
+## Usage
+
+You can get a list of the token owner's releaseable escrows through the OAuth client. You can also use the client to release an escrow.
+
+### View Releaseable Escrows
+
+``` ruby
+escrows = client.escrows
+
+escrows.each do |e|
+  e.data.created_at     # => UTC datetime escrow was created at
+  e.data.buyer_username # => username of the buyer
+  e.data.reference_code # => reference code for the escrow
+  
+  e.actions.release_url # => url to release to escrow
+end
+```
+
+Use the release_url from `escrows` method in the `escrow_release` method below:
+
+### Release An Escrow
+
+``` ruby
+# returns a complimentary message if the escrow successfully released
+release = client.escrow_release(release_url)
+```
+
+### List Ads
+
+You can get a list of the token owner's ads with the following method:
+
+``` ruby
+ads = client.ads
+
+ads.each do |a|
+  a.data.visible    # => boolean value of the ad's visibility
+  a.data.email      # => valid e-mail string or null
+  a.data.location_string # => human-readable location
+  # and many more pieces of data!
+end
+```
+
+For a full list of info you can get with this method, view the [API documentation](https://localbitcoins.com/api-docs/).
+
+## License
+
+All code is released under the MIT License.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/localbitcoins/client/ads.rb

@@ -0,0 +1,24 @@
+module LocalBitcoins
+  module Ads
+    # Get a list of the token owner's ads
+    #
+    def ads()
+      data = oauth_request(:get, '/api/ads')
+      Hashie::Mash.new(data['ad_list'])
+    end
+
+    # Update one of the token owner's ads
+    #
+    # id             - id of the ad you want to update
+    # visibility     - the ad's visibility [boolean]
+    # min_amount     - minimum selling price [string or nil]
+    # max_amount     - maximum buying price [string or nil]
+    # price_equation - equation to calculate price [string]
+    #
+    # NOTE: Omitting min_amount or max_amount will unset them.
+    #
+    def update_ad(id, visibility, min_amount, max_amount, price_equation)
+      # Can't use this method until the Ads API is complete!
+    end
+  end
+end

data/lib/localbitcoins/client/escrows.rb

@@ -0,0 +1,21 @@
+module LocalBitcoins
+  module Escrows
+    # Get a list of the token owner's releaseable escrows 
+    #
+    def escrows()
+      data = oauth_request(:get, '/api/escrows')
+      Hashie::Mash.new(data['escrow_list'])
+    end
+
+    # Release an escrow
+    #
+    # release_url => the url of the escrow you want to release, 
+    #                probably found by running the `escrows`
+    #                method above
+    #
+    def escrow_release(release_url)
+      data = oauth_request(:post, release_url)
+      data['data']['message']
+    end
+  end
+end

data/lib/localbitcoins/client.rb

@@ -0,0 +1,27 @@
+require 'localbitcoins/client'
+require 'localbitcoins/client/escrows'
+require 'localbitcoins/client/ads'
+
+module LocalBitcoins
+  class Client
+    include LocalBitcoins::Escrows
+    include LocalBitcoins::Ads
+
+    attr_reader :oauth_token
+
+    # Initialize a LocalBitcoins::Client instance
+    #
+    # All API calls to LocalBitcoins require an OAuth token, so you 
+    # need to include one when you initialize the client.
+    #
+    # options[:oauth_token]
+    #
+    def initialize(options={})
+      unless options.kind_of?(Hash)
+        raise ArgumentError, "Options hash required."
+      end
+
+      @oauth_token = options[:oauth_token]
+    end
+  end
+end

data/lib/localbitcoins/errors.rb

@@ -0,0 +1,6 @@
+module LocalBitcoins
+  class Error              < StandardError; end
+  class ConfigurationError < Error; end
+  class Unauthorized       < Error; end
+  class NotFound           < Error; end
+end

data/lib/localbitcoins/request.rb

@@ -0,0 +1,38 @@
+require 'rest-client'
+require 'active_support/core_ext'
+require 'json'
+require 'hashie'
+
+module LocalBitcoins
+  module Request
+
+    protected
+
+    # Perform an OAuth API request. The client must be initialized 
+    # with a valid OAuth access token. All API requests to 
+    # LocalBitcoins currently require an access token.
+    #
+    # path   - Request path
+    # params - Parameters hash
+    #
+    def oauth_request(http_method, path, params={})
+      raise 'OAuth access token required!' unless @oauth_token
+      params.merge!('Accept'=>'application/json')
+      resp = @oauth_token.request(http_method, path, params)
+
+      case resp
+        when Net::HTTPUnauthorized
+          raise LocalBitcoins::Unauthorized
+        when Net::HTTPNotFound
+          raise LocalBitcoins::NotFound
+      end
+
+      parse(resp)
+    end
+
+    def parse(resp)
+      object = JSON.parse(resp.body)
+      object
+    end
+  end
+end

data/lib/localbitcoins/version.rb

@@ -0,0 +1,5 @@
+module LocalBitcoins
+  unless defined?(LocalBitcoins::VERSION)
+    VERSION = '0.0.2'
+  end
+end

data/lib/localbitcoins.rb

@@ -0,0 +1,41 @@
+require 'localbitcoins/version'
+require 'localbitcoins/errors'
+require 'localbitcoins/request'
+require 'localbitcoins/client'
+
+module LocalBitcoins
+  @@options = {}
+
+  # Create a new LocalBitcoins::Client instance
+  #
+  def self.new(options={})
+    LocalBitcoins::Client.new(options)
+  end
+
+  # Define a global configuration
+  #
+  # options[:client_id]
+  # options[:client_secret]
+  #
+  def self.configure(options={})
+    unless options.kind_of?(Hash)
+      raise ArgumentError, "Options hash required."
+    end
+    
+    @@options[:client_id]     = options[:client_id]
+    @@options[:client_secret] = options[:client_secret]
+    @@options
+  end
+  
+  # Returns global configuration hash
+  #
+  def self.configuration
+    @@options
+  end
+  
+  # Resets the global configuration
+  #
+  def self.reset_configuration
+    @@options = {}
+  end
+end

data/localbitcoins.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/localbitcoins/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "localbitcoins"
+  s.version     = LocalBitcoins::VERSION.dup
+  s.summary     = "LocalBitcoins API wrapper"
+  s.description = "Ruby wrapper for the LocalBitcoins API"
+  s.homepage    = "http://github.com/pemulis/localbitcoins"
+  s.authors     = ["John Shutt"]
+  s.email       = ["john.d.shutt@gmail.com"]
+  s.homepage    = "http://shutt.in"
+  s.license     = "MIT"
+  
+  s.add_development_dependency 'rspec',     '~> 2.13'
+  s.add_development_dependency 'webmock',   '~> 1.11'
+  
+  s.add_runtime_dependency 'json',          '~> 1.8.0'
+  s.add_runtime_dependency 'rest-client',   '~> 1.6'
+  s.add_runtime_dependency 'hashie',        '~> 2.0.2'
+  s.add_runtime_dependency 'activesupport', '~> 3'
+  s.add_runtime_dependency 'oauth',         '~> 0.4'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+end

data/spec/client_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'oauth'
+
+describe 'Client' do
+
+end

data/spec/localbitcoins_spec.rb

@@ -0,0 +1,4 @@
+require 'spec-helper'
+
+describe 'LocalBitcoins' do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'localbitcoins'
+require 'rest-client'
+require 'webmock'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: localbitcoins
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Shutt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Ruby wrapper for the LocalBitcoins API
+email:
+- john.d.shutt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/localbitcoins.rb
+- lib/localbitcoins/client.rb
+- lib/localbitcoins/client/ads.rb
+- lib/localbitcoins/client/escrows.rb
+- lib/localbitcoins/errors.rb
+- lib/localbitcoins/request.rb
+- lib/localbitcoins/version.rb
+- localbitcoins.gemspec
+- spec/client_spec.rb
+- spec/localbitcoins_spec.rb
+- spec/spec_helper.rb
+homepage: http://shutt.in
+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.0.3
+signing_key: 
+specification_version: 4
+summary: LocalBitcoins API wrapper
+test_files: []