instamojo-ruby 1.1.2

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-ruby"
+  gem.homepage = "http://github.com/Instamojo/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. Also supports listing, updation and details of Payments, Payments Requests and Refunds.}
+  gem.email = "dev-accounts@instamojo.com"
+  gem.authors = ["Instamojo Technologies"]
+  # 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-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.2

data/instamojo-ruby.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# 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-ruby"
+  s.version = "1.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Instamojo Technologies"]
+  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 = "dev-accounts@instamojo.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "instamojo-ruby.gemspec",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "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/Instamojo/Instamojo-rb"
+  s.licenses = ["MIT"]
+  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 = 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_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"])
+      s.add_development_dependency(%q<debugger>, ["~> 1.6"])
+    else
+      s.add_dependency(%q<faraday>, ["= 0.8.8"])
+      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"])
+      s.add_dependency(%q<debugger>, ["~> 1.6"])
+    end
+  else
+    s.add_dependency(%q<faraday>, ["= 0.8.8"])
+    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"])
+    s.add_dependency(%q<debugger>, ["~> 1.6"])
+  end
+end
+

data/lib/API/api.rb

@@ -0,0 +1,47 @@
+module Instamojo
+
+  class << API
+    private
+    def whitelist_parameters
+      API::WHITELISTED_API_PARAMS.each { |x| attr_reader x }
+    end
+  end
+
+  class API
+    WHITELISTED_API_PARAMS = [:api_key, :auth_token, :endpoint]
+    whitelist_parameters
+    attr_reader :client
+
+    def initialize(api_key = nil, auth_token = nil, endpoint = nil, options = {}, &block)
+      options = find_params(api_key, auth_token, endpoint, options, block)
+
+      options.select { |k, _| WHITELISTED_API_PARAMS.include? k.to_sym }.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def client
+      @client ||= Instamojo::Client.new(self, @endpoint)
+    end
+
+    def to_s
+      @endpoint ? sprintf("Instamojo API(key: %s, endpoint: %s)", @api_key, @endpoint): sprintf("Instamojo API(key: %s)", @api_key)
+    end
+
+    private
+
+    def find_params(api_key, auth_token, endpoint, options, block)
+      params = if api_key.is_a? Hash
+        api_key
+      elsif api_key
+        { api_key: api_key, auth_token: auth_token }
+      elsif block
+        struct = OpenStruct.new
+        block.call(struct) && struct.marshal_dump
+      else options
+      end
+      params.merge!(endpoint: endpoint) if endpoint
+      params
+    end
+  end
+end

data/lib/Instamojo-rb.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+require 'json'
+require 'uri'
+require 'ostruct'
+require 'rest_client'
+require_relative 'utility'
+require_relative 'common_object'
+require_relative 'response'
+require_relative 'base'
+require_relative 'API/api'
+require_relative 'client/link'
+require_relative 'client/payment'
+require_relative 'client/refund'
+require_relative 'client/client'
+require_relative 'client/payment_request'

data/lib/base.rb

@@ -0,0 +1,8 @@
+module Instamojo
+  HOST = "https://www.instamojo.com"
+  API_VERSION = "1.1"
+  DEBUG = false
+  class API
+
+  end
+end

data/lib/client/client.rb

@@ -0,0 +1,227 @@
+module Instamojo
+  class Client
+    attr_reader :connection_options, :app_id
+    attr_reader :request, :response
+    attr_reader :authorized
+
+    URL = Instamojo::HOST + "/api/" + Instamojo::API_VERSION
+
+    def connection_options
+      @connection_options = lambda do |connection|
+        connection.request :url_encoded
+        connection.response :logger if Instamojo::DEBUG # TODO: set DEBUG flag for this
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def initialize(api, endpoint)
+      @endpoint = endpoint || URL
+      @conn = Faraday.new(@endpoint, &connection_options)
+
+      #TODO: To abstract in /errors.rb
+      raise "Supply API with api_key before generating client" unless api.api_key
+
+      @api_key = api.api_key
+      @auth_token = api.auth_token
+      add_header "X-Api-Key", @api_key
+      if @auth_token
+        add_header "X-Auth-Token", @auth_token
+        get 'debug' # dummy request to verify supplied auth_token
+      else
+        @authorized = "Not authorized"
+      end
+    end
+
+    def get_connection_object
+      @conn
+    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(@request, params)
+        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 /links
+    def links_list(opts = {})
+      get('links', opts)
+      @response.success? ? @response.body[:links].map { |link| Instamojo::Link.new link, self } : @response
+    end
+
+
+    # GET /links/:slug
+    def link_detail(slug)
+      slug = slug.slug if slug.instance_of? Instamojo::Link
+      get("links/#{slug}")
+      @response.success? ? Instamojo::Link.new(@response.body[:link], self) : @response
+    end
+
+    # POST /links
+    def create_link(options = {}, &block)
+      options = set_options(options, &block)
+      options[:file_upload_json] = options[:file_upload] && upload_file(options.delete(:file_upload))
+      options[:cover_image_json] = options[:cover_image] && upload_file(options.delete(:cover_image))
+      post('links', options)
+      @response.success? ? Instamojo::Link.new(@response.body[:link], self) : @response
+    end
+
+    # PATCH /links/:slug
+    def edit_link(link = nil, options = {}, &block)
+      if link && link.is_a?(Instamojo::Link)
+        yield(link) if block_given?
+      else
+        options = set_options(options, &block)
+        link = Instamojo::Link.new(options, self)
+      end
+      patch("links/#{link.slug}", link.to_h)
+      @response.success? ? Instamojo::Link.new(@response.body[:link], self) : @response
+    end
+
+    # DELETE /links/:slug
+    def archive_link(slug)
+      delete("links/#{slug}")
+    end
+
+    # POST 'https://filepicker.io/api/store/S3'
+    def upload_file(filepath)
+      if filepath && (file=File.open(File.expand_path(filepath), 'rb'))
+        if (url=get_file_upload_url).is_a? String
+          resource = RestClient::Resource.new(url)
+          resource.post fileUpload: file
+        end
+      end
+    end
+
+
+    # GET /payments
+    def payments_list(opts = {})
+      get('payments', opts)
+      @response.success? ? @response.body[:payments].map { |payment| Instamojo::Payment.new payment, self } : @response
+    end
+
+    # GET /payments/:payment_id
+    def payment_detail(payment_id)
+      payment_id = payment_id.payment_id if payment_id.instance_of? Instamojo::Payment
+      get("payments/#{payment_id}")
+      @response.success? ? Instamojo::Payment.new(@response.body[:payment], self) : @response
+    end
+
+    # POST /payment-requests
+    def payment_request(options, &block)
+      set_options(options, &block)
+      post('payment-requests', options)
+      @response.success? ? Instamojo::PaymentRequest.new(@response.body[:payment_request], self) : @response
+    end
+
+    # GET /payment-requests
+    def payment_requests_list(opts = {})
+      get('payment-requests', opts)
+      @response.success? ? @response.body[:payment_requests].map { |payment_request| Instamojo::PaymentRequest.new payment_request, self } : @response
+    end
+
+    def payment_request_status(payment_request_id)
+      payment_request_id = payment_request_id.id if payment_request_id.instance_of? Instamojo::PaymentRequest
+      get("payment-requests/#{payment_request_id}") if payment_request_id
+      @response.success? ? Instamojo::PaymentRequest.new(@response.body[:payment_request], self) : @response
+    end
+
+    # GET /refunds
+    def refunds_list(opts = {})
+      get('refunds', opts)
+      @response.success? ? @response.body[:refunds].map { |refund| Instamojo::Refund.new refund, self } : @response
+    end
+
+    # GET /refunds/:refund_id
+    def refund_detail(refund_id)
+      get("refunds/#{refund_id}")
+      @response.success? ? Instamojo::Refund.new(@response.body[:refund], self) : @response
+    end
+
+    # POST /refunds
+    def create_refund(options = {}, &block)
+      options = set_options(options, &block)
+      post('refunds', options)
+      @response.success? ? Instamojo::Refund.new(@response.body[:refund], self) : @response
+    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
+      @response = 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, Authorized: %s)", @endpoint, @authorized)
+    end
+
+    private
+    def sanitize_request
+      @request.concat('/') unless request.end_with? "/"
+      @request[0] = '' if request.start_with? "/"
+    end
+
+    def sanitize_response
+      @response = Instamojo::Response.new(@response)
+      @authorized = @response.success?
+      @response
+    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
+
+      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
+
+    # GET /links/get_file_upload_url
+    def get_file_upload_url
+      get('links/get_file_upload_url')
+      @response.success? ? @response.body[:upload_url] : @response
+    end
+  end
+end

data/lib/client/link.rb

@@ -0,0 +1,60 @@
+module Instamojo
+
+=begin Example
+{
+                  "title" => "Foo product",
+            "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" => nil,
+               "timezone" => nil,
+                   "note" => nil,
+           "redirect_url" => nil,
+            "webhook_url" => nil,
+                 "status" => "Live",
+            "enable_pwyw" => false,
+            "enable_sign" => false,
+    "socialpay_platforms" => ""
+}
+=end
+
+  class Link
+    attr_accessor :title, :description, :slug, :shorturl, :url, :cover_image, :currency, :base_price, :quantity
+    attr_accessor :quantity_sold, :requires_shipping, :ships_within_days, :start_date, :end_date, :venue, :timezone
+    attr_accessor :note, :redirect_url, :webhook_url, :status, :enable_pwyw, :enable_sign, :socialpay_platforms
+
+    attr_reader :original
+
+    include CommonObject
+    detail_method :link_detail, :slug
+
+    def initialize(link, client)
+      assign_values(link)
+      @client = client # Reference to client
+    end
+
+    # Carry out update request on a Link
+    def save(&block)
+      @client.edit_link(self, {}, &block)
+    end
+
+    # Carry out DELETE request on a link
+    def archive
+      @client.archive_link(self.slug)
+    end
+
+    def to_s
+      sprintf("Instamojo Link(slug: %s, title: %s, shorturl: %s, status: %s)", slug, title, shorturl, status)
+    end
+  end
+end