sailplay 0.1.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+
+gem 'json'
+gem 'guard-bundler'
+gem 'guard-rspec'
+gem 'rb-fsevent'
+gem 'terminal-notifier-guard'
+
+# Specify your gem's dependencies in sailplay.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :cli => '--color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Nebolsin
+
+MIT License
+
+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,39 @@
+# Sailplay for Rails
+
+[![Gem Version](https://badge.fury.io/rb/sailplay.png)](http://badge.fury.io/rb/sailplay)
+[![Build Status](https://travis-ci.org/nebolsin/sailplay.png?branch=master)](https://travis-ci.org/nebolsin/sailplay)
+[![Coverage Status](https://coveralls.io/repos/nebolsin/sailplay/badge.png)](https://coveralls.io/r/nebolsin/sailplay)
+[![Code Climate](https://codeclimate.com/github/nebolsin/sailplay.png)](https://codeclimate.com/github/nebolsin/sailplay)
+
+Integrate your Rails-based store with [Sailplay](http://sailplay.ru) to give reward points to consumers for making purchases.
+
+This gem provides Ruby bindings for [Sailplay API](https://docs.google.com/document/d/1WZggz8i5EYbkAhbF790UB2M7qTzQq33AHBbq_7BNQcc/edit)
+and helpers for Rails integration.
+
+Sponsored by [Fotoshkola.net](http://fotoshkola.net).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sailplay'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sailplay
+
+## Usage
+
+TODO: describe `sailplay_client(options)` method
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/sailplay.rb

@@ -0,0 +1,109 @@
+require 'sailplay/version'
+
+require 'sailplay/client'
+require 'sailplay/error'
+require 'sailplay/configuration'
+require 'sailplay/response'
+
+require 'sailplay/api/base'
+require 'sailplay/api/user'
+require 'sailplay/api/gift'
+require 'sailplay/api/purchase'
+
+module Sailplay
+  class << self
+    # The client object is responsible for communication with Sailplay API server.
+    attr_writer :client
+
+    # A Sailplay configuration object.
+    attr_writer :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   Sailplay.configure do |config|
+    #     config.store_id = '123'
+    #     config.store_key = '4567890'
+    #     config.store_pin = '3131'
+    #     config.secure  = true
+    #   end
+    def configure
+      yield(configuration)
+      @client = Client.new(configuration)
+    end
+
+    # The configuration object.
+    # @see Sailplay.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def reset!
+      @client = nil
+      @configuration = nil
+    end
+
+    def logger
+      self.configuration.logger
+    end
+
+    # @param [String] phone
+    # @param [Hash]   options
+    #
+    # @option options [true|false] :auth — authenticate user
+    #
+    # @return [Sailplay::User]
+    def create_user(phone, options = {})
+      self.client.create_user(phone, options)
+    end
+
+    # @param [String] phone
+    # @param [Hash]   options
+    #
+    # @option options [true|false] :auth — authenticate user
+    #
+    # @return [Sailplay::User]
+    def find_user(phone, options = {})
+      self.client.find_user(phone, options)
+    end
+
+    # @param [String|Integer] phone_or_user_id
+    # @param [BigDecimal]     price
+    # @param [Hash]           options
+    #
+    # @option options [Integer] :order_id    —  ID заказа
+    # @option options [Decimal] :points_rate — коэффициент конвертации рублей в баллы. Может принимать значение из полуинтервала (0,1].
+    #                                          При отсутствии данного параметра, используется значение, указанное в настройках.
+    #                                          Формат points_rate=0.45
+    # @option options [true|false] :force_complete —  если true, транзакция считается подтвержденной несмотря на флаг в настройках.
+    #                                                 Данный аттрибут может быть использован, например, в случае когда часть оплат
+    #                                                 необходимо подтверждать, а про остальные известно что они уже подтверждены.
+    #
+    # @return [Sailplay::Purchase]
+    def create_purchase(phone_or_user_id, price, options = {})
+      self.client.create_purchase(phone_or_user_id, price, options)
+    end
+
+    # @param [Integer] order_id
+    # @param [Hash]    options
+    #
+    # @option options [BigDecimal] :price
+    def confirm_purchase(order_id, options = {})
+      self.client.confirm_purchase(order_id, options)
+    end
+
+
+      # @param [String] gift_public_key
+    def confirm_gift(gift_public_key)
+      self.client.confirm_gift(gift_public_key)
+    end
+
+    def request(method, url, params)
+      self.client.request(method, url, params)
+    end
+  end
+end

data/lib/sailplay/api/base.rb

@@ -0,0 +1,4 @@
+module Sailplay
+  class Base
+  end
+end

data/lib/sailplay/api/gift.rb

@@ -0,0 +1,34 @@
+require 'sailplay/api/base'
+
+module Sailplay
+  class Gift < Base
+    attr_accessor :id, :sku, :name, :pic, :view_url, :pick_url, :points
+
+    #{
+    #    sku: 5,
+    #    name: "Подарок 1",
+    #    pic: "gifts/gift/b6e011188b74d3e0d838fbbace84de92.jpeg",
+    #    pick_url: "http://sailplay.ru/api/v1/ecommerce/gifts/pick/?gift_id=15&user_phone=79266054612...,
+    #    points: 55,
+    #    id: 25
+    #}
+    def self.parse(json)
+      Sailplay::Gift.new(
+          :id => json[:id],
+          :sku => json[:sku],
+          :name => json[:name],
+          :pic => json[:pic],
+          :view_url => json[:view_url],
+          :pick_url => json[:pick_url],
+          :points => json[:points]
+      )
+    end
+
+    def initialize(attrs = {})
+      [:id, :sku, :name, :pic, :view_url, :pick_url, :points].each do |attr|
+        instance_variable_set("@#{attr}", attrs[attr])
+      end
+    end
+
+  end
+end

data/lib/sailplay/api/purchase.rb

@@ -0,0 +1,40 @@
+require 'sailplay/api/base'
+
+module Sailplay
+  class Purchase < Base
+    attr_accessor :id, :order_id, :price, :points_delta, :complete_date, :public_key
+    attr_accessor :user
+
+    #{
+    #    "complete_date":"2013-01-25T00:31:42.642",
+    #    "price":"10",
+    #    "id":8,
+    #    "points_delta":4,
+    #    "public_key":";ao08rj3tj09fu9jkwer20393urjflshg54h",
+    #    "order_num":87573,
+    #}
+    def self.parse(json)
+      purchase_json = json[:purchase]
+      purchase = Sailplay::Purchase.new(
+        :id => purchase_json[:id],
+        :order_id => purchase_json[:order_num],
+        :price => purchase_json[:price],
+        :points_delta => purchase_json[:points_delta],
+        :complete_date => purchase_json[:complete_date],
+        :public_key => purchase_json[:public_key]
+      )
+
+      if user_json = json[:user]
+        purchase.user = User.parse(user_json)
+      end
+
+      purchase
+    end
+
+    def initialize(options = {})
+      [:id, :order_id, :price, :points_delta, :complete_date, :public_key].each do |attr|
+        instance_variable_set("@#{attr}", options[attr])
+      end
+    end
+  end
+end

data/lib/sailplay/api/user.rb

@@ -0,0 +1,52 @@
+require 'sailplay/api/base'
+require 'sailplay/api/gift'
+
+module Sailplay
+  class User < Base
+    attr_accessor :id, :phone, :full_name, :points, :media_url, :available_gifts, :unavailable_gifts, :auth_hash
+
+    # {
+    #   user_phone: "79266054612",
+    #   auth_hash: "1a159580bc111be0c288eb90afbce6f42ee48bba",
+    #   user_points: 189,
+    #   media_url: "http://d3257v5wstjx8h.cloudfront.net/media/"
+    #   available_gifts: [
+    #     {
+    #       sku: 5,
+    #       name: "Подарок 1",
+    #       pic: "gifts/gift/b6e011188b74d3e0d838fbbace84de92.jpeg",
+    #       pick_url: "http://sailplay.ru/api/v1/ecommerce/gifts/pick/?gift_id=15&user_phone=79266054612&token=239b3282621115d2e71bc844d546b7dea4385326&store_department_id=19",
+    #       points: 55,
+    #       id: 25
+    #     }
+    #   ],
+    #   over_user_points_gifts: [
+    #     {
+    #       sku: 1,
+    #       name: "Подарок 2",
+    #       view_url: "http://sailplay.ru/gifts/view/97/",
+    #       pic: "gifts/gift/83dd4abd6f13495f222113416103b716.jpg",
+    #       points: 200,
+    #       id: 27
+    #     }
+    #   ]
+    # }
+    def self.parse(json)
+      Sailplay::User.new(
+          :phone => json[:user_phone] || json[:phone],
+          :points => json[:user_points] || json[:points],
+          :full_name => json[:full_name],
+          :media_url => json[:media_url],
+          :auth_hash => json[:auth_hash],
+          :available_gifts => (json[:available_gifts] || []).map {|gift_json| Gift.parse(gift_json)},
+          :unavailable_gifts => (json[:over_user_points_gifts] || []).map {|gift_json| Gift.parse(gift_json)}
+      )
+    end
+
+    def initialize(attrs = {})
+      [:id, :phone, :full_name, :points, :media_url, :auth_hash, :available_gifts, :unavailable_gifts].each do |attr|
+        instance_variable_set("@#{attr}", attrs[attr])
+      end
+    end
+  end
+end

data/lib/sailplay/client.rb

@@ -0,0 +1,255 @@
+require 'rest-client'
+require 'multi_json'
+require 'sailplay/configuration'
+require 'sailplay/error'
+require 'sailplay/response'
+
+module Sailplay
+  class Client
+    attr_reader :protocol,
+                :host,
+                :port,
+                :endpoint,
+                :secure,
+                :connection_options,
+                :store_id,
+                :store_key,
+                :store_pin
+
+    alias_method :secure?, :secure
+
+    def initialize(options = {})
+      [ :protocol,
+        :host,
+        :port,
+        :endpoint,
+        :secure,
+        :connection_options,
+        :store_id,
+        :store_key,
+        :store_pin
+      ].each do |option|
+        instance_variable_set("@#{option}", options[option])
+      end
+    end
+
+    # @param [String] phone
+    # @param [Hash]   options
+    #
+    # @option options [true|false] :auth — authenticate user
+    #
+    # @return [Sailplay::User]
+    def create_user(phone, options = {})
+      params = {:user_phone => phone}
+      params[:extra_fields] = 'auth_hash' if options[:auth]
+
+      response = request(:get, '/users/reg', :user_phone => phone)
+      if response.success?
+        User.parse(response.data)
+      else
+        raise APIError, "Cannot create user '#{phone}': #{response.error_message}"
+      end
+    end
+
+    # @param [String] phone
+    # @param [Hash]   options
+    #
+    # @option options [true|false] :auth — authenticate user
+    #
+    # @return [Sailplay::User]
+    def find_user(phone, options = {})
+      params = {:user_phone => phone}
+      params[:extra_fields] = 'auth_hash' if options[:auth]
+
+      response = Sailplay.request(:get, '/users/points-info', params)
+      if response.success?
+        User.parse(response.data)
+      else
+        raise APIError, "Cannot find a user '#{phone}': #{response.error_message}"
+      end
+    end
+
+    # options[:points_rate]    —  коэффициент конвертации рублей в баллы. Может принимать значение из полуинтервала (0,1].
+    #                             При отсутствии данного параметра, используется значение, указанное в настройках.
+    #                             Формат points_rate=0.45
+    # options[:force_complete] —  если true, транзакция считается подтвержденной несмотря на флаг в настройках.
+    #                             Данный аттрибут может быть использован, например, в случае когда часть оплат
+    #                             необходимо подтверждать, а про остальные известно что они уже подтверждены.
+    # options[:order_id]       —  ID заказа
+    #
+    # @return [Sailplay::Purchase]
+    def create_purchase(user_id, price, options = {})
+      params = {:price => price, :origin_user_id => user_id}
+
+      params[:user_phone] = options[:phone] if options[:phone]
+      params[:points_rate] = options[:points_rate] if options[:points_rate]
+      params[:force_complete] = options[:force_complete] if options[:force_complete]
+      params[:order_num] = options[:order_id] if options[:order_id]
+
+      params[:fields] = [:public_key, options[:order_id] && :order_num].compact.join(',')
+
+      response = Sailplay.request(:get, '/purchases/new', params)
+
+      if response.success?
+        Purchase.parse(response.data)
+      else
+        raise APIError, "Cannot create a purchase: #{response.error_message}"
+      end
+    end
+
+    # @param [Integer] order_id
+    # @param [Hash]    options
+    #
+    # @option options [BigDecimal] :price
+    def confirm_purchase(order_id, options = {})
+      params = {:order_num => order_id}
+      params[:new_price] = options[:price] if options[:price]
+
+      response = request(:get, '/purchases/confirm', params)
+
+      if response.success?
+        Purchase.parse(response.data)
+      else
+        raise APIError, "Cannot confirm a purchase: #{response.error_message}"
+      end
+    end
+
+    # @param [String] gift_public_key
+    def confirm_gift(gift_public_key)
+      params = {:gift_public_key => gift_public_key}
+      response = request(:get, '/ecommerce/gifts/commit-transaction', params)
+
+      if response.success?
+      else
+        raise APIError, "Cannot confirm a gift: #{response.error_message}"
+      end
+    end
+
+    def request(method, url, params = {})
+      execute_request(method, url, auth_params.merge(params))
+    end
+
+    def logger
+      Sailplay.logger
+    end
+
+    private
+
+    def auth_params
+      {:store_department_id => store_id, :token => api_token}
+    end
+
+    def api_url(url = '')
+      URI.parse("#{protocol}://#{host}:#{port}").merge("#{endpoint}/#{url}").to_s
+    end
+
+    def api_token
+      @api_token ||= login
+    end
+
+    def login
+      raise ConfigurationError, 'Missing client configuration: ' +
+          'please check that store_id, store_key and pin_code are ' +
+          'configured' unless credentials?
+
+      response = execute_request(:get, 'login', credentials)
+
+      if response.success?
+        response.data[:token]
+      else
+        raise AuthenticationError.new("Cannot authenticate on Sailplay. Check your config. (Response: #{response})")
+      end
+    end
+
+    def credentials
+      {
+          :store_department_id => @store_id,
+          :store_department_key => @store_key,
+          :pin_code => @store_pin
+      }
+    end
+
+    def credentials?
+      credentials.values.all?
+    end
+
+    def execute_request(method, url, params = {})
+      logger.debug(self.class) {"Starting #{method} request to #{url} with #{params.inspect}"}
+      url = api_url(url)
+      headers = @connection_options[:headers].merge(:params => params)
+
+      request_opts = {:method => method, :url => url, :headers => headers}
+
+      begin
+        response = RestClient::Request.execute(request_opts)
+      rescue RestClient::ExceptionWithResponse => e
+        if e.http_code && e.http_body
+          handle_api_error(e.http_code, e.http_body)
+        else
+          handle_restclient_error(e)
+        end
+      rescue RestClient::Exception, SocketError, Errno::ECONNREFUSED => e
+        handle_restclient_error(e)
+      end
+
+
+      http_code, http_body = response.code, response.body
+
+      logger.debug(self.class) {"\t HTTP Code -> #{http_code}"}
+      #logger.debug(self.class) {"\t HTTP Body -> #{http_body}"}
+
+      begin
+        json_body = MultiJson.load(http_body, :symbolize_keys => true)
+      rescue MultiJson::DecodeError
+        raise APIError.new("Invalid response object from API: #{http_body.inspect} (HTTP response code was #{http_code})", http_code, http_body)
+      end
+
+      #logger.debug(self.class) {"\t JSON Body -> #{json_body}"}
+
+      response = Response.new(json_body)
+
+      logger.debug(self.class) {"\t Valid     -> #{response.success?}"}
+      logger.debug(self.class) {"\t Payload   -> #{response.data}"}
+
+      response
+    end
+
+    def handle_restclient_error(e)
+      case e
+        when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+          message = "Could not connect to Sailplay (#{endpoint}). " +
+              "Please check your internet connection and try again. " +
+              "If this problem persists, let us know at support@sailplay.ru."
+        when SocketError
+          message = "Unexpected error communicating when trying to connect to Sailplay. " +
+              "HINT: You may be seeing this message because your DNS is not working. " +
+              "To check, try running 'host sailplay.ru' from the command line."
+        else
+          message = "Unexpected error communicating with Sailplay. " +
+              "If this problem persists, let us know at support@sailplay.ru."
+      end
+      message += "\n\n(Network error: #{e.message})"
+      raise APIConnectionError, message
+    end
+
+    def handle_api_error(http_code, http_body)
+      begin
+        error_obj = MultiJson.load(http_body, :symbolize_keys => true)
+        message = error_obj[:message]
+      rescue MultiJson::DecodeError
+        message = "Invalid response object from API: #{http_body.inspect} (HTTP response code was #{http_code})"
+        raise APIError.new(message, http_code, http_body)
+      end
+
+      case http_code
+        when 400, 404 then
+          raise InvalidRequestError.new(message, http_code, http_body, error_obj)
+        when 401
+          raise AuthenticationError.new(message, http_code, http_body, error_obj)
+        else
+          raise APIError.new(message, http_code, http_body, error_obj)
+      end
+    end
+
+  end
+end