leancloud-ruby-client 0.1.0

data/leancloud-ruby-client.gemspec

@@ -0,0 +1,166 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "leancloud-ruby-client"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alan deLevie", "Adam Alpern", "Dennis Zhuang"]
+  s.date = "2015-04-10"
+  s.description = "A simple Ruby client for the leancloud.cn REST API"
+  s.email = "killme2008@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "example.rb",
+    "features.md",
+    "fixtures/vcr_cassettes/test_acls_arent_objects.yml",
+    "fixtures/vcr_cassettes/test_array_add.yml",
+    "fixtures/vcr_cassettes/test_array_add_pointerizing.yml",
+    "fixtures/vcr_cassettes/test_array_add_unique.yml",
+    "fixtures/vcr_cassettes/test_batch_create_object.yml",
+    "fixtures/vcr_cassettes/test_batch_delete_object.yml",
+    "fixtures/vcr_cassettes/test_batch_run.yml",
+    "fixtures/vcr_cassettes/test_batch_update_nils_delete_keys.yml",
+    "fixtures/vcr_cassettes/test_batch_update_object.yml",
+    "fixtures/vcr_cassettes/test_contains_all.yml",
+    "fixtures/vcr_cassettes/test_cql.yml",
+    "fixtures/vcr_cassettes/test_created_at.yml",
+    "fixtures/vcr_cassettes/test_decrement.yml",
+    "fixtures/vcr_cassettes/test_deep_parse.yml",
+    "fixtures/vcr_cassettes/test_destroy.yml",
+    "fixtures/vcr_cassettes/test_empty_response.yml",
+    "fixtures/vcr_cassettes/test_eq_pointerize.yml",
+    "fixtures/vcr_cassettes/test_equality.yml",
+    "fixtures/vcr_cassettes/test_get.yml",
+    "fixtures/vcr_cassettes/test_get_installation.yml",
+    "fixtures/vcr_cassettes/test_get_missing.yml",
+    "fixtures/vcr_cassettes/test_image_file_associate_with_object.yml",
+    "fixtures/vcr_cassettes/test_image_file_save.yml",
+    "fixtures/vcr_cassettes/test_include.yml",
+    "fixtures/vcr_cassettes/test_new_model.yml",
+    "fixtures/vcr_cassettes/test_new_object.yml",
+    "fixtures/vcr_cassettes/test_nils_delete_keys.yml",
+    "fixtures/vcr_cassettes/test_object_id.yml",
+    "fixtures/vcr_cassettes/test_parse_delete.yml",
+    "fixtures/vcr_cassettes/test_pointer.yml",
+    "fixtures/vcr_cassettes/test_request_sms.yml",
+    "fixtures/vcr_cassettes/test_reset_password.yml",
+    "fixtures/vcr_cassettes/test_retries.yml",
+    "fixtures/vcr_cassettes/test_retries_404.yml",
+    "fixtures/vcr_cassettes/test_retries_404_correct.yml",
+    "fixtures/vcr_cassettes/test_retries_json_error.yml",
+    "fixtures/vcr_cassettes/test_retries_server_error.yml",
+    "fixtures/vcr_cassettes/test_save_installation.yml",
+    "fixtures/vcr_cassettes/test_save_with_sub_objects.yml",
+    "fixtures/vcr_cassettes/test_saving_boolean_values.yml",
+    "fixtures/vcr_cassettes/test_saving_nested_objects.yml",
+    "fixtures/vcr_cassettes/test_server_update.yml",
+    "fixtures/vcr_cassettes/test_simple_save.yml",
+    "fixtures/vcr_cassettes/test_text_file_save.yml",
+    "fixtures/vcr_cassettes/test_update.yml",
+    "fixtures/vcr_cassettes/test_updated_at.yml",
+    "fixtures/vcr_cassettes/test_user_login.yml",
+    "fixtures/vcr_cassettes/test_user_save.yml",
+    "fixtures/vcr_cassettes/test_xget.yml",
+    "leancloud-ruby-client.gemspec",
+    "lib/faraday/better_retry.rb",
+    "lib/faraday/extended_parse_json.rb",
+    "lib/faraday/get_method_override.rb",
+    "lib/leancloud-ruby-client.rb",
+    "lib/leancloud/application.rb",
+    "lib/leancloud/batch.rb",
+    "lib/leancloud/client.rb",
+    "lib/leancloud/cloud.rb",
+    "lib/leancloud/datatypes.rb",
+    "lib/leancloud/error.rb",
+    "lib/leancloud/installation.rb",
+    "lib/leancloud/model.rb",
+    "lib/leancloud/object.rb",
+    "lib/leancloud/protocol.rb",
+    "lib/leancloud/push.rb",
+    "lib/leancloud/query.rb",
+    "lib/leancloud/user.rb",
+    "lib/leancloud/util.rb",
+    "test/cloud_functions/MyCloudCode/cloud/main.js",
+    "test/config/global.json",
+    "test/helper.rb",
+    "test/middleware/better_retry_test.rb",
+    "test/middleware/extend_parse_json_test.rb",
+    "test/parsers.jpg",
+    "test/test_batch.rb",
+    "test/test_client.rb",
+    "test/test_cloud.rb",
+    "test/test_datatypes.rb",
+    "test/test_file.rb",
+    "test/test_init.rb",
+    "test/test_init_from_cloud_code.rb",
+    "test/test_installation.rb",
+    "test/test_model.rb",
+    "test/test_object.rb",
+    "test/test_push.rb",
+    "test/test_query.rb",
+    "test/test_throttle.rb",
+    "test/test_user.rb"
+  ]
+  s.homepage = "http://github.com/killme2008/leancloud-ruby-client"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.6"
+  s.summary = "A simple Ruby client for the leancloud.cn REST API"
+
+  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"])
+      s.add_runtime_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<test-unit>, ["= 2.5.0"])
+      s.add_development_dependency(%q<mocha>, ["= 0.12.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.5"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.9.0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<test-unit>, ["= 2.5.0"])
+      s.add_dependency(%q<mocha>, ["= 0.12.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.5"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<webmock>, ["~> 1.9.0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<faraday_middleware>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<test-unit>, ["= 2.5.0"])
+    s.add_dependency(%q<mocha>, ["= 0.12.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.5"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<webmock>, ["~> 1.9.0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/lib/faraday/better_retry.rb

@@ -0,0 +1,94 @@
+# -*- encoding : utf-8 -*-
+require 'ostruct'
+module Faraday
+  # Catches exceptions and retries each request a limited number of times.
+  #
+  # By default, it retries 2 times and handles only timeout exceptions. It can
+  # be configured with an arbitrary number of retries, a list of exceptions to
+  # handle an a retry interval.
+  #
+  # Examples
+  #
+  #   Faraday.new do |conn|
+  #     conn.request :retry, max: 2, interval: 0.05,
+  #                          exceptions: [CustomException, 'Timeout::Error']
+  #     conn.adapter ...
+  #   end
+  class BetterRetry < Faraday::Middleware
+    class Options < OpenStruct
+
+      def max
+        (self[:max] ||= 2).to_i
+      end
+
+      def interval
+        (self[:interval] ||= 0).to_f
+      end
+
+      def exceptions
+        Array(self[:exceptions] ||= [Errno::ETIMEDOUT, 'Timeout::Error', Error::TimeoutError])
+      end
+
+      # define for ruby less than 2.0
+      def [](name)
+        @table[name.to_sym]
+      end
+
+      def []=(name, value)
+        modifiable[new_ostruct_member(name)] = value
+      end
+
+    end
+
+    # Public: Initialize middleware
+    #
+    # Options:
+    # max        - Maximum number of retries (default: 2).
+    # interval   - Pause in seconds between retries (default: 0).
+    # exceptions - The list of exceptions to handle. Exceptions can be
+    #              given as Class, Module, or String. (default:
+    #              [Errno::ETIMEDOUT, Timeout::Error, Error::TimeoutError])
+    def initialize(app, options = {})
+      super(app)
+      @options = Options.new(options)
+      @errmatch = build_exception_matcher(@options.exceptions)
+      @logger = options[:logger]
+    end
+
+    def call(env)
+      env[:retries] = retries = @options.max
+      begin
+        @app.call(env)
+      rescue @errmatch => e
+        if retries > 0
+          if @logger
+            @logger.warn("Retrying Parse Error #{e.inspect} on request #{env[:url].to_s} #{env[:body].inspect} response #{env[:response].inspect}")
+          end
+          retries -= 1
+          env[:retries] = retries
+          sleep @options.interval if @options.interval > 0
+          retry
+        end
+        raise
+      end
+    end
+
+    # Private: construct an exception matcher object.
+    #
+    # An exception matcher for the rescue clause can usually be any object that
+    # responds to `===`, but for Ruby 1.8 it has to be a Class or Module.
+    def build_exception_matcher(exceptions)
+      matcher = Module.new
+      (class << matcher; self; end).class_eval do
+        define_method(:===) do |error|
+          exceptions.any? do |ex|
+            if ex.is_a? Module then error.is_a? ex
+            else error.class.to_s == ex.to_s
+            end
+          end
+        end
+      end
+      matcher
+    end
+  end
+end

data/lib/faraday/extended_parse_json.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+module Faraday
+
+  class ExtendedParseJson < FaradayMiddleware::ParseJson
+
+    def process_response(env)
+      env[:raw_body] = env[:body] if preserve_raw?(env)
+
+
+      if env[:status] >= 400
+        data = parse(env[:body]) || {} rescue {}
+
+        array_codes = [
+          AV::Protocol::ERROR_INTERNAL,
+          AV::Protocol::ERROR_TIMEOUT,
+          AV::Protocol::ERROR_EXCEEDED_BURST_LIMIT
+        ]
+        error_hash = { "error" => "HTTP Status #{env[:status]} Body #{env[:body]}", "http_status_code" => env[:status] }.merge(data)
+        if data['code'] && array_codes.include?(data['code'])
+          sleep 60 if data['code'] == AV::Protocol::ERROR_EXCEEDED_BURST_LIMIT
+          raise exception(env).new(error_hash.merge(data))
+        elsif env[:status] >= 500
+          raise exception(env).new(error_hash.merge(data))
+        end
+        raise AV::AVProtocolError.new(error_hash)
+      else
+        data = parse(env[:body]) || {}
+
+        env[:body] = data
+      end
+    end
+
+    def exception env
+      # decide to retry or not
+      (env[:retries].to_i.zero? ? AV::AVProtocolError : AV::AVProtocolRetry)
+    end
+
+  end
+end

data/lib/faraday/get_method_override.rb

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+
+require 'faraday'
+
+module Faraday
+  # Public: Writes the original HTTP method to "X-Http-Method-Override" header
+  # and sends the request as POST for GET requests that are too long.
+  class GetMethodOverride < Faraday::Middleware
+
+    HEADER = "X-Http-Method-Override".freeze
+
+    # Public: Initialize the middleware.
+    #
+    # app     - the Faraday app to wrap
+    def initialize(app, options = nil)
+      super(app)
+    end
+
+    def call(env)
+      if env[:method] == :get && env[:url].to_s.size > 2000
+        env[:request_headers][HEADER] = 'GET'
+        env[:request_headers]['Content-Type'] =
+          'application/x-www-form-urlencoded'
+        env[:body] = env[:url].query
+        env[:url].query = nil
+        env[:method] = :post
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/leancloud-ruby-client.rb

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+## ----------------------------------------------------------------------
+##
+## Ruby client for parse.com
+## A quick library for playing with parse.com's REST API for object storage.
+## See https://parse.com/docs/rest for full documentation on the API.
+##
+## ----------------------------------------------------------------------
+require 'rubygems'
+require 'bundler/setup'
+
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/better_retry'
+require 'faraday/extended_parse_json'
+require 'faraday/get_method_override'
+require 'date'
+require 'cgi'
+
+cwd = Pathname(__FILE__).dirname
+$:.unshift(cwd.to_s) unless $:.include?(cwd.to_s) || $:.include?(cwd.expand_path.to_s)
+
+require 'leancloud/object'
+require 'leancloud/query'
+require 'leancloud/datatypes'
+require 'leancloud/util'
+require 'leancloud/protocol'
+require 'leancloud/user'
+require "leancloud/installation"
+require 'leancloud/push'
+require 'leancloud/cloud'
+require 'leancloud/model'
+require 'leancloud/batch'
+require 'leancloud/application'

data/lib/leancloud/application.rb

@@ -0,0 +1,7 @@
+module AV
+  class Application
+    def self.config
+      AV.client.request(AV::Protocol.config_uri)['params']
+    end
+  end
+end

data/lib/leancloud/batch.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+module AV
+  class Batch
+    attr_reader :requests
+    attr_reader :client
+
+    def initialize(client = AV.client)
+      @client = client
+      @requests ||= []
+    end
+
+    def add_request(request)
+      @requests << request
+    end
+
+    def create_object(object)
+      method = "POST"
+      path = AV::Protocol.class_uri(object.class_name)
+      body = object.safe_hash
+      add_request({
+        "method" => method,
+        "path" => path,
+        "body" => body
+      })
+    end
+
+    def update_object(object)
+      method = "PUT"
+      path = AV::Protocol.class_uri(object.class_name, object.id)
+      body = object.safe_hash
+      add_request({
+        "method" => method,
+        "path" => path,
+        "body" => body
+      })
+    end
+
+    def delete_object(object)
+      add_request({
+        "method" => "DELETE",
+        "path" => AV::Protocol.class_uri(object.class_name, object.id)
+      })
+    end
+
+    def run!
+      uri = AV::Protocol.batch_request_uri
+      body = {:requests => @requests}.to_json
+      @client.request(uri, :post, body)
+    end
+
+  end
+
+end

data/lib/leancloud/client.rb

@@ -0,0 +1,149 @@
+# -*- encoding : utf-8 -*-
+require 'leancloud/protocol'
+require 'leancloud/error'
+require 'leancloud/util'
+
+require 'logger'
+module AV
+
+  # A class which encapsulates the HTTPS communication with the Parse
+  # API server.
+  class Client
+    attr_accessor :host
+    attr_accessor :application_id
+    attr_accessor :api_key
+    attr_accessor :master_key
+    attr_accessor :session_token
+    attr_accessor :session
+    attr_accessor :max_retries
+    attr_accessor :logger
+    attr_accessor :quiet
+
+    def initialize(data = {}, &blk)
+      @host           = data[:host] || Protocol::HOST
+      @application_id = data[:application_id]
+      @api_key        = data[:api_key]
+      @master_key     = data[:master_key]
+      @session_token  = data[:session_token]
+      @max_retries    = data[:max_retries] || 3
+      @logger         = data[:logger] || Logger.new(STDERR).tap{|l| l.level = Logger::INFO}
+      @quiet          = data[:quiet] || false
+
+      options = {:request => {:timeout => 30, :open_timeout => 30}}
+
+      @session = Faraday.new("https://#{host}", options) do |c|
+        c.request :json
+
+        c.use Faraday::GetMethodOverride
+
+        c.use Faraday::BetterRetry,
+          max: @max_retries,
+          logger: @logger,
+          interval: 0.5,
+          exceptions: ['Faraday::Error::TimeoutError', 'Faraday::Error::ParsingError', 'AV::AVProtocolRetry']
+        c.use Faraday::ExtendedParseJson
+
+        c.response :logger, @logger unless @quiet
+        c.adapter Faraday.default_adapter
+
+        yield(c) if block_given?
+      end
+    end
+
+    # Perform an HTTP request for the given uri and method
+    # with common basic response handling. Will raise a
+    # AVProtocolError if the response has an error status code,
+    # and will return the parsed JSON body on success, if there is one.
+    def request(uri, method = :get, body = nil, query = nil, content_type = nil)
+      headers = {}
+
+      {
+        "Content-Type"                  => content_type || 'application/json',
+        "User-Agent"                    => 'Parse for Ruby, 0.0',
+        Protocol::HEADER_MASTER_KEY     => @master_key,
+        Protocol::HEADER_APP_ID         => @application_id,
+        Protocol::HEADER_API_KEY        => @api_key,
+        Protocol::HEADER_SESSION_TOKEN  => @session_token,
+      }.each do |key, value|
+        headers[key] = value if value
+      end
+
+      @session.send(method, uri, query || body || {}, headers).body
+    end
+
+    def get(uri)
+      request(uri)
+    end
+
+    def post(uri, body)
+      request(uri, :post, body)
+    end
+
+    def put(uri, body)
+      request(uri, :put, body)
+    end
+
+    def delete(uri)
+      request(uri, :delete)
+    end
+
+  end
+
+
+  # Module methods
+  # ------------------------------------------------------------
+  class << self
+    # A singleton client for use by methods in Object.
+    # Always use AV.client to retrieve the client object.
+    @client = nil
+
+    # Initialize the singleton instance of Client which is used
+    # by all API methods. AV.init must be called before saving
+    # or retrieving any objects.
+    def init(data = {}, &blk)
+      defaults = {:application_id => ENV["LC_APPLICATION_ID"], :api_key => ENV["LC_APPLICATION_KEY"]}
+      defaults.merge!(data)
+
+      # use less permissive key if both are specified
+      defaults[:master_key] = ENV["PARSE_MASTER_API_KEY"] unless data[:master_key] || defaults[:api_key]
+      @@client = Client.new(defaults, &blk)
+    end
+
+    # A convenience method for using global.json
+    def init_from_cloud_code(path = "../config/global.json")
+      # warning: toplevel constant File referenced by AV::Object::File
+      global = JSON.parse(Object::File.open(path).read)
+      application_name  = global["applications"]["_default"]["link"]
+      application_id    = global["applications"][application_name]["applicationId"]
+      master_key        = global["applications"][application_name]["masterKey"]
+      self.init(:application_id => application_id, :master_key => master_key)
+    end
+
+    # Used mostly for testing. Lets you delete the api key global vars.
+    def destroy
+      @@client = nil
+      self
+    end
+
+    def client
+      raise AVError, "API not initialized" if !@@client
+      @@client
+    end
+
+    # Perform a simple retrieval of a simple object, or all objects of a
+    # given class. If object_id is supplied, a single object will be
+    # retrieved. If object_id is not supplied, then all objects of the
+    # given class will be retrieved and returned in an Array.
+    def get(class_name, object_id = nil)
+      data = self.client.get( Protocol.class_uri(class_name, object_id) )
+      self.parse_json class_name, data
+    rescue AVProtocolError => e
+      if e.code == Protocol::ERROR_OBJECT_NOT_FOUND_FOR_GET
+        e.message += ": #{class_name}:#{object_id}"
+      end
+      raise
+    end
+  end
+
+end
+