Instamojo-rb 0.1.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjFlZWVlYTA1OWFlMmVkYTQ3MzMwZDI5NmZmYWU2NGQ4OTFhMzFmYw==
+  data.tar.gz: !binary |-
+    MTlhNTczZmM3MTliY2Q0OTYxNWI2OWFjYWFmMGYyOGRiNDBiOTc3ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    MWM1YzUzZTBiMTgyMmNhODljZDM3Y2ZlZTNiMjZjYjVlMjFkYmIxNDE3YTk0
+    YTRhZWMwNDViMjllMjYxOGIxNmU0MzE0NDI4NGVjMWY1Y2IyNDUwMTdlZjU5
+    OTA5ZGQ2NDVmMjU5ZGRhMmMyMDQxYTkyMjgxMzQ1NzI3ZDM1NTc=
+  data.tar.gz: !binary |-
+    Njk1ZDFmYWFhZTkyM2Q4NjI3NWRlNjc4MjljZjcyODEzZDM1ZjAyM2U2Y2Ey
+    YTQ1OTU2M2Y2ZGYwNmQyYTZjYTU4ZjEyYjU4ZjJkMzNlMTIyNDhkNWQzNjQx
+    ZGQ4OTJiNzg4MGU0MzhiYjFlZGQxODgwNDViNTJlMGYzOTVkOTc=

data/Gemfile

@@ -3,14 +3,13 @@ source "http://rubygems.org"
 # 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.0"
-  gem "rdoc", "~> 3.12"
+  gem "rspec", "~> 2.8"
   gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8.7"
-  gem "faraday", "0.8.8"
-  gem "debugger"
+  gem "jeweler", "~> 1.8"
+  gem "debugger", "~> 1.6"
 end

data/Gemfile.lock

@@ -11,6 +11,8 @@ GEM
     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)
@@ -23,6 +25,8 @@ GEM
       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
@@ -36,9 +40,11 @@ GEM
     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)
@@ -51,6 +57,10 @@ GEM
     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)
@@ -59,14 +69,15 @@ GEM
     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
+  debugger (~> 1.6)
   faraday (= 0.8.8)
-  jeweler (~> 1.8.7)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
+  jeweler (~> 1.8)
+  rest-client (~> 1.8)
+  rspec (~> 2.8)

data/Instamojo-rb.gemspec

@@ -2,15 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: Instamojo-rb 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "Instamojo-rb"
-  s.version = "0.1.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Ankur Goel"]
-  s.date = "2014-02-01"
-  s.description = "Instamojo Ruby library - Assists you to programmatically create, edit and delete offers on Instamojo"
+  s.date = "2015-12-18"
+  s.description = "Instamojo Ruby library - Assists you to programmatically create, edit and delete offers on Instamojo. Also supports listing, updation and details of Payments, Payments Requests and Refunds."
   s.email = "ankurgel@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -30,45 +32,48 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/API/api.rb",
     "lib/Instamojo-rb.rb",
+    "lib/base.rb",
     "lib/client/client.rb",
+    "lib/client/link.rb",
+    "lib/client/payment.rb",
+    "lib/client/payment_request.rb",
+    "lib/client/refund.rb",
+    "lib/common_object.rb",
+    "lib/response.rb",
     "lib/utility.rb",
     "spec/Instamojo-rb_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/AnkurGel/Instamojo-rb"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "2.2.2"
   s.summary = "Instamojo Ruby library - Assists you to programmatically create, edit and delete offers on Instamojo"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<faraday>, ["= 0.8.8"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.8"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_development_dependency(%q<faraday>, ["= 0.8.8"])
-      s.add_development_dependency(%q<debugger>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<debugger>, ["~> 1.6"])
     else
       s.add_dependency(%q<faraday>, ["= 0.8.8"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rest-client>, ["~> 1.8"])
+      s.add_dependency(%q<rspec>, ["~> 2.8"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_dependency(%q<faraday>, ["= 0.8.8"])
-      s.add_dependency(%q<debugger>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<debugger>, ["~> 1.6"])
     end
   else
     s.add_dependency(%q<faraday>, ["= 0.8.8"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rest-client>, ["~> 1.8"])
+    s.add_dependency(%q<rspec>, ["~> 2.8"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-    s.add_dependency(%q<faraday>, ["= 0.8.8"])
-    s.add_dependency(%q<debugger>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<debugger>, ["~> 1.6"])
   end
 end
 

data/README.md

@@ -1,99 +1,258 @@
-#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.
+# 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-rb`    
-
-For your Rails/bundler projects:    
+## Installation
+`gem install Instamojo-rb`
+For your Rails/bundler projects:
 `gem 'Instamojo-rb'`
 
-##Usage##
-
-###Set API keys###
+## Usage
+### Set API keys
 ```ruby
 require 'Instamojo-rb'
 api = Instamojo::API.new do |app|
-  app.app_id = "app_id-you-received-from-api@instamojo.com"
+  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("app_id-you-received-from-api@instamojo.com")
+api = Instamojo::API.new("api_key-you-received-from-api@instamojo.com", "auth_token-you-received-from-api@instamojo.com")
 ```
-
-###Generate client:###
+### Generate client
 `client = api.client`
 
-###Authentication###
+---
+### Links
+
+`Link` object contains all the necessary information required to interpret, modify and archive an Instamojo Link. All link operations on client returns one or collectionn of `links`. Original response from Instamojo API for a link is encapsulated in `link.original`, which is immutable. Call `#to_h` on `link` to get it's 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 it's usage is below.
+
+
+#### Get Links
 ```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)
+client.links_list
+#=> Array of Instamojo::Link objects
 ```
 
-###Offers###
-####List all offers####
-`client.get_offers`
+#### Create a new link
+##### Required:
+* `title` - Title of the Link, 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 Link. 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 Link 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.
 
-####List details of an offer####
-**Syntax:** `client.get_offer(offer_slug)`
+##### 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
-client.get_offer('demo-product')
-#=> {"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"=>""},
-# "success"=>true}
+new_link = client.create_link do |link|
+  link.title = 'API link 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-link-v11, title: API link v1.1, shorturl: )
+new_link.reload!
+#=> Instamojo Link(slug: api-link-v11, title: API link v1.1, shorturl: http://imojo.in/1dxv1h)
+```
+or
+```ruby
+new_link_params = {base_price: 199, title: 'API link 3', description: 'My dummy offer via API', currency: 'INR', quantity: 20}
+new_link = client.create_link(new_link_params)
 ```
 
-####Create an offer####
+#### Detail of a link
 ```ruby
-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
+link = client.link_detail('link_slug_goes_here')
+#=> Instamojo Link(slug: link_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 link
+```ruby
+link = client.links_list.first
+link.save do |l|
+  l.title = "Foo"
+  l.description = "This new information should go in link"
 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 link'
+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 link'})
+```
+
+---
+### 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!`
 
-#OR
-client.create_offer({
-  "title" => "Command line offer",
-  "description" => "This offer is being created via Instamojo-rb",
-  "currency" => "INR",
-  "base_price" => 0,
-  "quantity" => 0
-})
+Details are documented [here](https://www.instamojo.com/developers/rest/#toc-payments)
+
+#### Get Payments
+```ruby
+client.payments_list
+#=> Returns array of Payment objects
+```
+#### 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-link-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
+```
+#### 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!`.
 
-####Archive an offer####
-`client.delete_offer('demo-product')`
+#### Get Refunds
+```ruby
+refunds = client.refunds_list
+#=> Returns array of Refund objects
+```
 
-###Logout###
-`client.logout`
+#### 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
+```
 
-##Development pipeline##
+#### 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.
 
-Few things which will be available in next versions:
+#### 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.
 
-* 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`
-  + `offer.set_title('Changed offer title')`
-  + `offer.set_quantity(30)`
-  + `offer.enable_variants`
 
-##Contributing##
+## 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/`. 
+* `rake install` to install the gem.
+* Swim around in `lib/`.
 
-##Copyright##
+## Copyright
 
 Copyright (c) 2014 Ankur Goel.