Instamojo-rb

This is the Ruby library of Instamojo API.
This will assist you to programmatically create, edit and delete offers on Instamojo.

Installation

gem install Instamojo-rb

For your Rails/bundler projects:
gem 'Instamojo-rb'

Usage

Set API keys

require 'Instamojo-rb'
api = Instamojo::API.new do |app|
  app.app_id = "[email protected]"
end
#or
api = Instamojo::API.new("[email protected]")

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

Syntax: client.get_offer(offer_slug)

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}

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

client.delete_offer('demo-product')

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
- offer.set_title('Changed offer title')
- offer.set_quantity(30)
- offer.enable_variants

Contributing

Fork the project
bundle install to satisfy gem dependencies.
rake install to install the gem.
Swim around in lib/.