Instamojo-rb 0.1.0

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"
+
+# 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 "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "faraday", "0.8.8"
+  gem "debugger"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+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)
+    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)
+    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)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.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)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  debugger
+  faraday (= 0.8.8)
+  jeweler (~> 1.8.7)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

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,99 @@
+#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 your Rails/bundler projects:    
+`gem 'Instamojo-rb'`
+
+##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"
+end
+#or
+api = Instamojo::API.new("app_id-you-received-from-api@instamojo.com")
+```
+
+###Generate client:###
+`client = api.client`
+
+###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)
+```
+
+###Offers###
+####List all offers####
+`client.get_offers`
+
+####List details of an offer####
+**Syntax:** `client.get_offer(offer_slug)`
+
+```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}
+```
+
+####Create an offer####
+```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
+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](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/`. 
+
+##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.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "Instamojo-rb"
+  gem.homepage = "http://github.com/AnkurGel/Instamojo-rb"
+  gem.license = "MIT"
+  gem.summary = %Q{Instamojo Ruby library - Assists you to programmatically create, edit and delete offers on Instamojo}
+  gem.description = %Q{Instamojo Ruby library - Assists you to programmatically create, edit and delete offers on Instamojo}
+  gem.email = "ankurgel@gmail.com"
+  gem.authors = ["Ankur Goel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Instamojo-rb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/API/api.rb

@@ -0,0 +1,25 @@
+module Instamojo
+  class API
+    attr_accessor :app_id
+
+    def initialize(app_id = nil, options = {})
+      options = app_id if app_id.is_a? Hash
+
+      @app_id = app_id
+
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      yield self if block_given?
+    end
+
+    def client
+      Instamojo::Client.new(self)
+    end
+
+    def to_s
+      sprintf("Instamojo API(key: %s)", @app_id)
+    end
+  end
+end

data/lib/Instamojo-rb.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+require 'json'
+require 'uri'
+require 'ostruct'
+require_relative 'API/api'
+require_relative 'client/client'
+require_relative 'utility'
+
+module Instamojo
+  URL = "https://www.instamojo.com"
+  PREFIX = "/api/1"
+end

data/lib/client/client.rb

@@ -0,0 +1,168 @@
+module Instamojo
+  class Client
+    attr_reader :connection_options, :app_id
+    attr_reader :request, :response
+    attr_reader :authentication_flag
+
+    def connection_options
+      @connection_options = lambda do |connection|
+        connection.request :url_encoded
+        connection.response :logger
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def initialize(api)
+      @conn = Faraday.new(Instamojo::URL, &connection_options)
+
+      #TODO: To abstract in /errors.rb
+      raise "Supply API with app_id before generating client" unless api.app_id
+
+      @app_id = api.app_id
+      add_header("X-App-Id", @app_id)
+      @authentication_flag = "Not authenticated"
+    end
+
+    def get_connection_object
+      @conn #Faraday::Connection object
+    end
+
+
+    def self.define_http_verb(http_verb)
+      define_method http_verb do |*args|
+        request = args[0] || "/"
+        params = args[1] || {}
+
+        @request = request
+        sanitize_request
+        method = @conn.method(http_verb)
+        @response = method.call(Instamojo::PREFIX + @request, params)
+        return sanitize_response
+      end
+    end
+
+    define_http_verb :get
+    define_http_verb :post
+    define_http_verb :patch
+    define_http_verb :delete
+
+
+    #POST /auth/
+    #Authenticate, generate token and add header
+    def authenticate(username = nil, password = nil, options = {}, &block)
+      if username.is_a?(Hash) or password.is_a?(Hash)
+        options = username.is_a?(Hash) ? username : password
+      end
+      options["username"] = username if username and !username.is_a?Hash
+      options["password"] = password if password and !password.is_a?Hash
+
+      options = set_options(options, &block)
+
+      #TODO: Raise error if doesn't find username and password key in options
+      @response = post('auth', options)
+      if @response.has_key?("success") and @response['success']
+        add_header("X-Auth-Token", @response['token'])
+      end
+      @response
+    end
+
+
+    #GET /offer - List all offers
+    def get_offers
+      unless get_connection_object.headers.has_key?("X-Auth-Token")
+        raise "Please authenticate() to see your offers"
+      end
+      get('offer')
+    end
+
+    #GET /offer/:slug
+    def get_offer(slug)
+      get("offer/#{slug}")
+    end
+
+
+    #POST /offer/ - Create an offer
+    def create_offer(options = {}, &block)
+      options = set_options(options, &block)
+      @response = post('offer', options)
+    end
+
+    #PATCH /offer/
+    def edit_offer(slug, options = {}, &block)
+      options = set_options(options, &block)
+      patch("/offer/#{slug}", options)
+    end
+
+    #DELETE /offer/:slug - Archives an offer
+    def delete_offer(slug)
+      unless get_connection_object.headers.has_key?("X-Auth-Token")
+        raise "Please authenticate() to see your offers"
+      end
+      delete("/offer/#{slug}")
+    end
+
+    #Uploading file and cover images
+    def upload_file
+      #TODO
+    end
+
+
+    #DELETE /auth/:token - Delete auth token
+    def logout
+      auth_token = get_connection_object.headers['X-Auth-Token']
+      raise "Can't find any authorization token to logout." unless auth_token
+      delete("/auth/#{auth_token}")
+      if @response.has_key?("success") and @response['success']
+        get_connection_object.headers.delete("X-Auth-Token")
+      end
+      @response
+    end
+
+
+    def to_s
+      sprintf("Instamojo Client(URL: %s, Status: %s)",
+              Instamojo::URL + Instamojo::PREFIX,
+              @authentication_flag
+      )
+    end
+
+
+    private
+    def sanitize_request
+      @request.concat('/') unless request.end_with? "/"
+      @request.prepend('/') unless request.start_with? "/"
+    end
+
+    def sanitize_response
+      if @response.status == 200
+        @authentication_flag = "Authenticated"
+        JSON.parse(@response.body)
+      else
+        begin
+          ({:client_error => "Something went wrong",
+            :response_code => @response.status
+          }).merge(JSON.parse(@response.body))
+        rescue JSON::ParserError
+          {:response_code => @response.status}
+        end
+      end
+    end
+
+    def set_options(options, &block)
+      if block_given?
+        block_params = OpenStruct.new
+        block.call(block_params)
+        options = options.merge(block_params.marshal_dump)
+      end
+      #to tackle collective hash like:
+      #{"username" => "foo", :username => "foo"}
+      #added non-recursive basic code in lib/utility.rb
+      options.symbolize_keys!
+    end
+
+    def add_header(key, value)
+      previous_headers = get_connection_object.headers
+      get_connection_object.headers = previous_headers.merge({key => value})
+    end
+  end
+end

data/lib/utility.rb

@@ -0,0 +1,15 @@
+module Instamojo
+
+  class ::Hash
+    def symbolize_keys
+      self.inject({}) do |initial, (k, v)|
+        initial[k.to_sym] = v
+        initial
+      end
+    end
+
+    def symbolize_keys!
+      self.replace(self.symbolize_keys)
+    end
+  end
+end

data/spec/Instamojo-rb_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "InstamojoRb" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'Instamojo-rb'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: Instamojo-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ankur Goel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instamojo Ruby library - Assists you to programmatically create, edit
+  and delete offers on Instamojo
+email: ankurgel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/API/api.rb
+- lib/Instamojo-rb.rb
+- lib/client/client.rb
+- lib/utility.rb
+- spec/Instamojo-rb_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/AnkurGel/Instamojo-rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -260583537
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Instamojo Ruby library - Assists you to programmatically create, edit and
+  delete offers on Instamojo
+test_files: []