straight-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9971b5eec958a69dfda8afd798f2f0078bda14cd
-  data.tar.gz: 557e882978d3a74f91565ba64954f52c83d396c6
+  metadata.gz: 709cce413b5edf3d2ae1a54d8de9f72eb754acfa
+  data.tar.gz: 72cf89d6129ad8e252f69182936886f92b208297
 SHA512:
-  metadata.gz: 214f0fb557485f0bc0b384e4da3d2ea0ca3e370a302395e7d142492a368c5e83306fc6af04d91a33593abc7a8d0fa6e357e3aa43ea98a4fd9b521e8481bfc28b
-  data.tar.gz: 92778fd7ff3ff18f16a3bfec4d9152134778b11680984ff0c931a6c82d384c71dc12d93200f784ea7fec44d21371a051a439beb58430ff9fc160971610819ed7
+  metadata.gz: f24eb5307a0a96a0920baa889ad3e099aebcff75863d248b8d863d5d259b1a61c9c73b00239154d8fe636be16f4f55448beef94ecdd5042c3aac082d7685ed16
+  data.tar.gz: fd7b712c58d2c4240575fb10cead4579e426f578ac7fb7e413e724f5e3ea1f41ff2e9efcc6242a53b992a31fb7f4d452422c5aabe578eebf5857daa1e8cee78c

data/README.md

@@ -1,6 +1,6 @@
-# Straight::Api
+# Straight-API
 
-TODO: Write a gem description
+Straight API is a API wrapper for [Straight Server](https://github.com/snitko/straight-server) for ruby and ruby on rails.
 
 ## Installation
 
@@ -18,14 +18,70 @@ Or install it yourself as:
 
     $ gem install straight-api
 
+
+and then require it in your ruby application:
+
+```ruby
+require 'straight-api'
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### Initialize
+
+Create a new instance of Straight:
+
+```ruby
+straight = Straight.new("http://localhost:9696", 1)
+```
+
+The first parameter the host of your Straight Server instance, and the second parameter is the gateway ID. You can include any extra parameters which will be included in every request.
+
+### Create an Order
+
+You can create a new order:
+
+```ruby
+order = straight.new(1, :currency => "USD")
+```
+
+The first parameter is the amount. You can include any extra parameters (currency, etc.) which will be included in the request.
+
+You can access the ID, status, tid, amount and address of your new order:
+
+```ruby
+id = order.id
+status = order.status
+tid = order.tid
+amount = order.amount
+address = order.address
+```
+
+### Get an Order
+
+You can get the information of an order:
+
+```ruby
+order = straight.get(1)
+```
+
+The first parameter is the order's ID. You can include any extra parameters which will be included in the request.
+
+You can access the ID, status, tid, amount and address of the order:
+
+```ruby
+id = order.id
+status = order.status
+tid = order.tid
+amount = order.amount
+address = order.address
+```
 
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/straight-api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+3. Add your features and write tests for them
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/lib/straight-api.rb

@@ -8,7 +8,7 @@ class Straight
 
   def initialize (uri, gateway, options={})
     self.class.base_uri "#{uri}/gateways/#{gateway}"
-    @options = options
+    @options = {query: options}
   end
 
   def create (amount, options={})

data/lib/straight-api/version.rb

@@ -1,3 +1,3 @@
 class Straight
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: straight-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manthan Mallikarjun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler