Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 3.5 KB

README.md

File metadata and controls

97 lines (64 loc) · 3.5 KB

BTCJam API Client Demo

This app is an example of a BTCJam API OAuth2 client. It uses rails, devise and omniauth gems. OAuth2 strategy is build on top of abstract OAuth2 strategy for OmniAuth

This app is live here.

About the BTCJam API

For more information about the API check here, this project is hosted here.

The user info returned currently is:

info['alias']
info['country']
info['positive_count_reputation']
info['negative_count_reputation]
info['positive_percentage_reputation']
info['can_borrow']
info['can_trade']
info['btcjam_score']
info['bitcointalk_account_verified']
info['address_verified']
info['identity_verified']
info['phone_verified']
info['facebook_connected']
info['facebook_friend_count']
info['linkedin_connected']
info['ebay_connected']
info['ebay_account_date']
info['ebay_feedback_score']
info['paypal_verified_account_connected']
info['paypal_account_date']
info['repaid_loans_count']
info['repaid_loans_amount']
info['late_loans_count']
info['open_credit_lines_count']
info['open_credit_lines_amount']
info['made_late_payments_count']
info['balance']

Installation & Configuration

If you want to run the application by yourself here are the steps for you.

First you need to clone the repository from GitHub

git clone git://github.com/btcjam/btcjam-client.git

Install all the gems

bundle install

And migrate the databse

rake db:migrate

At this point the application should be ready to run, but it won't communicate correctly with the provider.

Go to BTCJam and register your application using the settings tab at the dashboard.

The callback url for this application will look like this

http://localhost:3000/users/auth/btcjam/callback

You need to set up environment variables to indicate the oauth2 provider values. In your environemnt file set up these variables

BTCJAM_APP_ID = "375c2e3fd..." # ID for your app registered at BTCJam
BTCJAM_APP_SECRET = "6a2fa82ab..." # Secret
BTCJAM_APP_URL = "https://btcjam.com" # BTCJam API URL

Now you are ready to start the app

rails s

License

Copyright (c) 2013 by Ovo Cósmico

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.