instamojo-ruby 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c22eccfe2814ce57f124728f71fce854c27760ee83584420a2989e859e976df
+  data.tar.gz: 889f92aee37dd3305ba01be179f0c7189248f9e9c96e3cb9b639d9c21290c86f
+SHA512:
+  metadata.gz: 945216e78b02a84146f03a40224627c45d7af8563a44687512f0747f7311cb60d54b612fe97c98da2dfa04d3d486be8fa68ce09eb7b4e2437943a63354a993b7
+  data.tar.gz: e9df688d4cc84207fd549c276bd693ce3d41137262290fadc01e21edf82b486193b578543dccdc475566daf1227611d9ebb505a200008a76fced302a9d3f4652

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "faraday", "0.8.8"
+gem 'rest-client', '~> 1.8'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8"
+  gem "debugger", "~> 1.6"
+end

data/Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    columnize (0.3.6)
+    debugger (1.6.5)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.1)
+    diff-lcs (1.1.3)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (2.99)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    netrc (0.11.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    unf (0.2.0.beta2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  debugger (~> 1.6)
+  faraday (= 0.8.8)
+  jeweler (~> 1.8)
+  rest-client (~> 1.8)
+  rspec (~> 2.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Ankur Goel
+
+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,287 @@
+# Instamojo-rb
+This is the **Ruby** library of [Instamojo REST API](https://www.instamojo.com/developers/rest/).
+This will assist you to programmatically create, edit and delete links on Instamojo. Also supports [RAP](https://www.instamojo.com/developers/request-a-payment-api/) api for payments request, listing and status.
+
+## Installation
+`gem install instamojo-ruby`
+For your Rails/bundler projects:
+`gem 'instamojo-ruby'`
+
+## Usage
+### Set API keys
+```ruby
+require 'Instamojo-rb'
+api = Instamojo::API.new do |app|
+  app.api_key = "api_key-you-received-from-api@instamojo.com"
+  app.auth_token = "auth_token-you-received-from-api@instamojo.com"
+end
+#or
+api = Instamojo::API.new("api_key-you-received-from-api@instamojo.com", "auth_token-you-received-from-api@instamojo.com")
+```
+
+**Note**: If you're using this wrapper with our sandbox environment `https://test.instamojo.com/` then you should pass `'https://test.instamojo.com/api/1.1/'` as third argument to the `Instamojo` class while initializing it. API key and Auth token for the same can be obtained from https://test.instamojo.com/developers/ (Details: [Test Or Sandbox Account](https://instamojo.zendesk.com/hc/en-us/articles/208485675-Test-or-Sandbox-Account)).
+
+    api = Instamojo::API.new("api_key", "auth_token", "https://test.instamojo.com/api/1.1/")
+
+### Generate client
+`client = api.client`
+
+---
+### Products
+
+`Link` object contains all the necessary information required to interpret, modify and archive an Instamojo product. All product operations on client returns one or collection of `products`. Original response from Instamojo API for a product is encapsulated in `link.original`, which is immutable. Call `#to_h` on `link` to get its all attributes.
+_Helper methods_ for `Link`:
+* `link.to_h` - Returns equivalent Ruby hash for a link.
+* `link.to_json` - Returns equivalent JSON for a link
+* `link.original` - Returns original link data fetched from API.
+* `link.save` - Edits updates carried out on Link object at Instamojo.
+* `link.archive` - Archives link at Instamojo
+* `link.reload` or `link.refresh` - Looks for changes on Instamojo server for the link. Immutable
+* `link.reload!` or `link.refresh!` - Same as `link.reload`, but mutable.
+
+ More about its usage is below.
+
+
+#### Get Products
+```ruby
+client.links_list
+#=> Array of Instamojo::Link objects
+```
+##### Supports optional pagination
+```ruby
+client.links_list(page:1, limit:10)
+#=> Array of 10 Link objects (page 1)
+```
+
+#### Create a new product
+##### Required:
+* `title` - Title of the product, be concise.
+* `description` - Describe what your customers will get, you can add terms and conditions and any other relevant information here. Markdown is supported, popular media URLs like Youtube, Flickr are auto-embedded.
+* `base_price` - Price of the product. This may be 0, if you want to offer it for free.
+
+##### File and Cover image:
+* `file_upload` - Full path to the file you want to sell. This file will be available only after successful payment.
+* `cover_image` - Full path to the IMAGE you want to upload as a cover image.
+
+##### Quantity:
+* `quantity` - Set to 0 for unlimited sales. If you set it to say 10, a total of 10 sales will be allowed after which the product will be made unavailable.
+
+##### Post Purchase Note
+* `note` - A post-purchase note, will only displayed after successful payment. Will also be included in the ticket/ receipt that is sent as attachment to the email sent to buyer. This will not be shown if the payment fails.
+
+##### Event
+* `start_date` - Date-time when the event is beginning. Format: `YYYY-MM-DD HH:mm`
+* `end_date` - Date-time when the event is ending. Format: `YYYY-MM-DD HH:mm`
+* `venue` - Address of the place where the event will be held.
+* `timezone` - Timezone of the venue. Example: Asia/Kolkata
+
+##### Redirects and Webhooks
+* `redirect_url` - This can be a Thank-You page on your website. Buyers will be redirected to this page after successful payment.
+* `webhook_url` - Set this to a URL that can accept POST requests made by Instamojo server after successful payment.
+* `enable_pwyw` - set this to True, if you want to enable Pay What You Want. Default is False.
+* `enable_sign` - set this to True, if you want to enable Link Signing. Default is False. For more information regarding this, and to avail this feature write to support at instamojo.com.
+
+##### Code:
+```ruby
+new_link = client.create_link do |link|
+  link.title = 'API product v1.1'
+  link.description = 'Dummy offer via API'
+  link.currency = 'INR'
+  link.base_price = 0
+  link.quantity = 10
+  link.redirect_url = 'http://ankurgoel.com'
+  link.file_upload = '~/Pictures/RISE.jpg'
+  link.cover_image = '~/Pictures/saturday.jpg'
+end
+#=> Instamojo Link(slug: api-product-v11, title: API product v1.1, shorturl: )
+new_link.reload!
+#=> Instamojo Link(slug: api-product-v11, title: API product v1.1, shorturl: http://imojo.in/1dxv1h)
+```
+or
+```ruby
+new_product_params = {base_price: 199, title: 'API product 3', description: 'My dummy offer via API', currency: 'INR', quantity: 20}
+new_link = client.create_link(new_product_params)
+```
+
+#### Details of a product
+```ruby
+link = client.link_detail('product_slug_goes_here')
+#=> Instamojo Link(slug: product_slug_goes_here, title: Foo Bar, shorturl: http://imojo.in/ankurfoobar)
+link.to_h
+#=> {"title"=>"Foo Bar", "description"=>"", "slug"=>"foo-product", "shorturl"=>"http://imojo.in/ankurfoobar", "url"=>"https://www.instamojo.com/ankurgel/foo-product/", "cover_image"=> "https://www.filepicker.io/api/file/BHeefKAARCKGC5l1J29e/convert?w=500&h=500&fit=clip&quality=70", "currency"=>"INR", "base_price"=>"0.00", "quantity"=>nil, "quantity_sold"=>2, "requires_shipping"=>false, "ships_within_days"=>nil, "start_date"=>nil, "end_date"=>nil, "venue"=>"", "timezone"=>"", "note"=>"", "redirect_url"=>"", "webhook_url"=>"", "status"=>"Live", "enable_pwyw"=>false, "enable_sign"=>false, "socialpay_platforms"=>""}
+```
+
+#### Edit a product
+```ruby
+link = client.links_list.first
+link.save do |l|
+  l.title = "Foo"
+  l.description = "This new information should go in product"
+end
+#=> Returns updated Link object from Instamojo
+```
+or
+```ruby
+link = client.link_detail('foo-product')
+link.title = 'Foo'; link.description = 'This new information should go in product'
+link.save
+# returns updated Link object from Instamojo
+```
+or handle it directly without Link object
+```ruby
+client.edit_link({slug: 'foo-product', title: 'Foo', description: 'This new infromation should go in product'})
+```
+
+---
+### Payments
+`Payment` object contains the necessary information such as `payment_id`, `quantity`, `status`, `buyer_email` etc. Call `#to_h` on `payment` to get it's all attributes. `Payment` object has following helpers:
+- `payment.to_h` - Returns equivalent Ruby hash for a payment
+- `payment.to_json` - Returns equivalent JSON for a payment
+- `payment.original` - Returns original payment data fetched from API.
+- Like `Link`, it also exposes `reload` and `reload!`
+
+Details are documented [here](https://www.instamojo.com/developers/rest/#toc-payments)
+
+#### Get Payments
+```ruby
+client.payments_list
+#=> Returns array of Payment objects
+```
+##### Supports optional pagination
+```ruby
+client.payments_list(page:1, limit:10)
+#=> Array of 10 Payment objects (page 1)
+```
+#### Detail or status of a payment
+```ruby
+payment = client.payment_detail('MOJxxx06000F97367750')
+#=> Instamojo Payment(payment_id: MOJxxx06000F97367750, quantity: 1, amount: 0.00, status: Credit, link_slug: api-product-7-node, buyer_name: Ankur Goel)
+payment.to_h
+#=> Hash of all payment object attributes
+```
+#### Request a payment
+This is a part of [RAP API](https://www.instamojo.com/developers/request-a-payment-api/). You can request a payment from anyone via this who will then be notified to make a payment with specified payment. The payment then can be carried out via [Instapay](https://www.instamojo.com/pay/). Jump over to the documentation to see accepted parameters.
+##### Code:
+```ruby
+payment_request = client.payment_request({amount:100, purpose: 'api', send_email: true, email: 'ankurgel+2@gmail.com', redirect_url: 'http://ankurgoel.com'})
+#=> Instamojo PaymentRequest(id: 8726f8c5001e426f8b24e908b2761686, purpose: api, amount: 100.00, status: Sent, shorturl: , longurl: https://www.instamojo.com/@ashwini/8726f8c5001e426f8b24e908b2761686)
+```
+#### Get Payment Requests
+```ruby
+payment_requests = client.payment_requests_list
+#=> Returns array of PaymentRequest objects
+```
+##### Supports optional pagination
+```ruby
+client.payment_requests_list(page:1, limit:10)
+#=> Array of 10 PaymentRequest objects (page 1)
+```
+#### Status of payment request
+You can get the status of a payment_request from the id you obtained after making payment request.
+```ruby
+payment_request.reload!
+#or
+payment_request = client.payment_request_status('8726f8c5001e426f8b24e908b2761686')
+#=> Instamojo PaymentRequest(id: 8726f8c5001e426f8b24e908b2761686, purpose: api, amount: 100.00, status: Sent, shorturl: http://imjo.in/Nasdf , longurl: https://www.instamojo.com/@ashwini/8726f8c5001e426f8b24e908b2761686)
+```
+---
+### Refunds
+`Refund` object contains the necessary information such as `payment_id`, `refund_amount`, `status` and `body` etc. Call `#to_h` on `refund` to get it's all attributes. `Refund` object has the same helpers as `Payment` above, including `reload` and `reload!`.
+
+#### Get Refunds
+```ruby
+refunds = client.refunds_list
+#=> Returns array of Refund objects
+```
+##### Supports optional pagination
+```ruby
+client.refunds_list(page:1, limit:10)
+#=> Array of 10 Refund objects (page 1)
+```
+#### Create a new refund
+##### Required:
+* `payment_id` - Payment ID of the payment against which you're initiating the refund.
+* `type` - A three letter short-code identifying the [reason for this case](https://www.instamojo.com/developers/rest/#toc-refunds).
+* `body` - Additonal text explaining the refund.
+
+```ruby
+client.create_refund({payment_id: 'MOJO5c04000J30502939', type: 'QFL', body: 'Customer is not satisfied'})
+#=> Returns Refund object or non-200 response object
+```
+or
+```ruby
+client.create_refund do |refund|
+  refund.payment_id = 'MOJO5c04000J30502939'
+  refund.type       = 'QFL'
+  refund.body       = 'Customer is not satisifed'
+end
+```
+or refund a `payment` directly:
+```ruby
+payment = client.payment_detail('MOJO5c05000F97367750')
+payment.process_refund(type: 'QFL', body: 'User wanted different version') #or
+payment.process_refund do |refund|
+  refund.type = 'QFL'
+  refund.body = 'User wanted different version'
+end
+```
+
+#### Details of a refund
+```ruby
+refund = client.refund_detail 'C5c0751269'
+#=> Instamojo Refund(id: C5c0751269, status: 'Refunded' payment_id: MOJO5c04000J30502939, refund_amount: 100)
+refund.to_h
+#=> Hash of all refund attributes
+refund.reload!
+#=> Updates the refund from server
+#=> Instamojo Refund(id: C5c0751269, status: 'Closed' payment_id: MOJO5c04000J30502939, refund_amount: 100)
+```
+or
+```ruby
+refunds = client.refunds_list
+refund = refunds.last
+refund.reload #=> refetches the refund from server
+#=> Instamojo Refund(id: C5c0751269, status: 'Refunded' payment_id: MOJO5c04000J30502939, refund_amount: 100)
+```
+
+---
+### Authentication
+```ruby
+client.authenticate('instamojo_username', 'instamojo_password')
+#or
+client.authenticate do |user|
+  user.username = "instamojo_username"
+  user.password = "instamojo_password"
+end
+#=> Instamojo Client(URL: https://www.instamojo.com/api/1, Status: Authenticated)
+```
+#### Logout
+```ruby
+client.logout
+```
+---
+### Misc
+* `client.authorized` - View last status of api client request.
+* `client.response` - View last procured response by client.
+* `client.response.code` - View `response_code` of last request sent by client.
+
+#### Logging
+If you are interested in seeing api requests being made to Instamojo server. Flip this flag: `Instamojo::DEBUG = true` and genereate the api client again.
+
+
+## Contributing
+
+* [Fork](https://github.com/AnkurGel/Instamojo-rb/fork) the project
+* `bundle install` to satisfy gem dependencies.
+* `rake install` to install the gem.
+* Swim around in `lib/`.
+
+## Contributors
+1. Ashwini Chaudhary - [@ashwch](https://github.com/ashwch)
+   * [PR #3](https://github.com/AnkurGel/Instamojo-rb/pull/3) - Couple of minor fixes.
+   * [PR #4](https://github.com/AnkurGel/Instamojo-rb/pull/4) - Class wrapper over Payment Request. Code fixes.
+
+## Copyright
+
+Copyright (c) 2014 Ankur Goel.
+

data/README.rdoc

@@ -0,0 +1,89 @@
+= Instamojo-rb
+
+This is the *Ruby* library of {Instamojo API}[http://instamojo.com/developers].   
+This will assist you to programmatically create, edit and delete offers on Instamojo. 
+
+== Installation
+       gem install Instamojo-rb
+
+For Rails/bundler projects:
+       gem 'Instamojo-rb'
+
+== Usage
+
+=== Set API keys
+       require 'Instamojo-rb'
+       api = Instamojo::API.new do |app|
+         app.app_id = "app_id-you-received-from-api@instamojo.com"
+       end
+       #or
+       api = Instamojo::API.new("app_id-you-received-from-api@instamojo.com")
+
+=== Generate Client
+       client = api.client
+
+=== Authentication
+       client.authenticate('instamojo_username', 'instamojo_password')
+       #or
+       client.authenticate do |user|
+         user.username = "instamojo_username"
+         user.password = "instamojo_password"
+       end
+       #=> Instamojo Client(URL: https://www.instamojo.com/api/1, Status: Authenticated)
+
+=== Offers
+
+==== List all offers
+
+       client.get_offers
+
+==== List details of an offer
+
+       offer_slug = "my-foo-product"
+       client.get_offer(offer_slug)     
+       #=> {"offer"=> {"shorturl"=>nil, "start_date"=>nil, "note"=>"", "description"=>"This is a demo product. Just *claim* it. ", "venue"=>nil, "title"=>"Demo product", "url"=>"https://www.instamojo.com/ankurgel/demo-product/", "slug"=>"demo-product", "base_price"=>"0.00", "quantity"=>nil, "end_date"=>nil, "currency"=>"INR", "cover_image"=>nil, "timezone"=>nil, "redirect_url"=>""},
+
+==== Create an offer
+       
+       client.create_offer do |offer|
+         offer.title = "Command line offer"
+         offer.description = "This offer is being created via Instamojo-rb"
+         offer.currency = "INR"
+         offer.base_price = 0
+         offer.quantity = 0
+       end
+
+       #OR
+       client.create_offer({
+           "title" => "Command line offer",
+           "description" => "This offer is being created via Instamojo-rb",
+           "currency" => "INR",
+           "base_price" => 0,
+           "quantity" => 0
+       })
+
+==== Archive an offer
+
+       offer_slug = "my-foo-product"
+       client.delete_offer(offer_slug)
+
+==== Logout
+       client.logout
+
+
+== Development Pipeline
+Few things which will be available in next versions:
+
+* Error handling; with respect to `Instamojo` error codes.
+* File Upload support. 
+* +Offer+ and +Event+ model with api methods like   
+  * _Accessor_ methods like on +Offer+: +#title+, +#description+, +#quantity+
+  * Functional setters: +offer.set_title('Changed offer title')+
+  *                     +offer.set_quantity(30)+
+  * +offer.enable_variants+
+
+ 
+== Copyright
+
+Copyright (c) 2014 Ankur Goel. See LICENSE.txt for further details.
+