lvmama-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a8f92ae21ea4f0b15cd4f7ac2cb8b936e001fba
+  data.tar.gz: 6ce22a3ed7daf4b87584e317fa6e97dd537f7be0
+SHA512:
+  metadata.gz: 68fba6090fc71f3d0d968af8a905ca87675a6adaf7c769c047497cb494f821e930f6144c366fcbd7ec5a4bf86a57058b2006257f73cc0b25e810df20ad1e8485
+  data.tar.gz: 55a8bab8f9f902576bdf6313a7785e4df4b4daff8ce8b7919771e3404c23062c7676c08ae4e8dd5df43be0b967b1d81db1996536bcb1f35ef471f1e544efb4f2

data/.gitignore

@@ -0,0 +1,2 @@
+debugger.rb
+

data/README.md

@@ -0,0 +1,32 @@
+The Lvmama API Ruby Gem
+====================
+A simple Ruby wrapper for the Lvmama APIs.
+
+It's not a official Ruby Gem.
+If you want to get the origin document, please contact: [http://www.lvmama.com/](http://www.lvmama.com/).
+
+Installation
+------------
+	gem install lvmama-api 
+
+
+Configuration
+-------------
+
+```ruby
+Lvmama.configure do |config|
+  config.client_id = 'appKey'
+  config.client_secret = 'secret'
+end
+```
+
+Usage
+-----
+
+```ruby
+# Get the scenic list
+response = Lvmama.scenic_info_list_by_page 1
+
+# Use the response
+response[:scenicNameList][0][:scenicId]
+```

data/Rakefile

@@ -0,0 +1,3 @@
+task :console do
+  exec "irb -r lvmama-api -r faraday -r faraday_middleware -I ./lib"
+end

data/lib/lvmama-api.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../lvmama-api/error', __FILE__)
+require File.expand_path('../lvmama-api/configuration', __FILE__)
+require File.expand_path('../lvmama-api/api', __FILE__)
+require File.expand_path('../lvmama-api/client', __FILE__)
+
+module Lvmama
+  extend Configuration
+
+  # Alias for Lvmama::Client.new
+  #
+  # @return [Lvmama::Client]
+  def self.client(options={})
+    Lvmama::Client.new(options)
+  end
+
+  # Delegate to Lvmama::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Lvmama::Client
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+end

data/lib/lvmama-api/api.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module Lvmama
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Lvmama.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/lvmama-api/client.rb

@@ -0,0 +1,9 @@
+module Lvmama
+  # Wrapper for the Lvmama REST API
+
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include Lvmama::Client::TicketProd
+  end
+end

data/lib/lvmama-api/client/ticket_prod.rb

@@ -0,0 +1,47 @@
+module Lvmama
+  class Client
+    module TicketProd
+      ENDPOINT = "distributorApi/2.0/api/ticketProd/".freeze
+
+      def scenic_info_list_by_page current_page, options={}
+        options[:currentPage] = current_page
+        response = post ENDPOINT + "scenicInfoListByPage", options
+        response
+      end
+
+      def product_info_list_by_page current_page, options={}
+        options[:currentPage] = current_page
+        response = post ENDPOINT + "productInfoListByPage", options
+        response
+      end
+
+      def product_price_list_by_page current_page, begin_date, end_date, options={}
+        options[:currentPage] = current_page
+        options[:beginDate] = begin_date
+        options[:endDate] = end_date
+        response = post ENDPOINT + "productPriceListByPage", options
+        response
+      end
+
+      def product_info_list product_ids, options={}
+        options[:productIds] = product_ids
+        response = post ENDPOINT + "productInfoList", options
+        response
+      end
+
+      def good_info_list goods_ids, options={}
+        options[:goodsIds] = goods_ids
+        response = post ENDPOINT + "goodInfoList", options
+        response
+      end
+
+      def good_price_list goods_ids, begin_date, end_date, options={}
+        options[:goodsIds] = goods_ids
+        options[:beginDate] = begin_date
+        options[:endDate] = end_date
+        response = post ENDPOINT + "goodPriceList", options
+        response
+      end
+    end
+  end
+end

data/lib/lvmama-api/configuration.rb

@@ -0,0 +1,86 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Lvmama
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Lvmama::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :client_id,
+      :client_secret,
+      :connection_options,
+      :endpoint,
+      :format,
+      :user_agent,
+    ].freeze
+
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CLIENT_ID = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET = nil
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'http://api.lvmama.com'.freeze
+    # Develop endpoint
+    #DEFAULT_ENDPOINT = 'http://180.169.51.94/api1/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Lvmama Ruby Gem #{Lvmama::VERSION}".freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json].freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.user_agent         = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/lvmama-api/connection.rb

@@ -0,0 +1,27 @@
+require 'faraday_middleware'
+
+module Lvmama
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+        :url => endpoint,
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        unless raw
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          end
+        end
+        #connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/lvmama-api/error.rb

@@ -0,0 +1,31 @@
+module Lvmama
+  # Custom error class for rescuing from all Lvmama errors
+  class Error < StandardError; end
+
+  # Raised when Lvmama returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+
+  # Raised when Lvmama returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
+end

data/lib/lvmama-api/request.rb

@@ -0,0 +1,60 @@
+require 'digest'
+
+module Lvmama
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false)
+      response = connection(raw).send(method) do |request|
+        timestamp = Time.now.getutc.to_i
+        sign = generate_sign timestamp.to_s, client_secret
+
+        options[:appKey] = client_id
+        options[:messageFormat] = format
+        options[:timestamp] = timestamp
+        options[:sign] = sign
+
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(path)
+          request.body = options unless options.empty?
+        end
+      end
+
+      raw ? response : response.body
+    end
+
+    def generate_sign timestamp, secret
+      sign = secret + timestamp + secret
+      md5 = Digest::MD5.new
+      md5 << sign
+      md5.hexdigest
+    end
+
+  end
+end
+

data/lib/lvmama-api/version.rb

@@ -0,0 +1,3 @@
+module Lvmama
+  VERSION = '0.1.0'
+end

data/lvmama-api.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/lvmama-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Samwise Wang"]
+  gem.email         = ["wangjunzhe4444@gmail.com"]
+  gem.description   = %q{A Ruby wrapper for the Lvmama API}
+  gem.summary       = %q{Ruby wrapper for the Lvmama API}
+  gem.homepage      = "https://github.com/tzwm/lvmama-api-ruby"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "lvmama-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Lvmama::VERSION.dup
+  gem.license       = 'MIT'
+
+  gem.add_dependency 'faraday', '~> 0.9.1'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.1'
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: lvmama-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samwise Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: A Ruby wrapper for the Lvmama API
+email:
+- wangjunzhe4444@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- lib/lvmama-api.rb
+- lib/lvmama-api/api.rb
+- lib/lvmama-api/client.rb
+- lib/lvmama-api/client/ticket_prod.rb
+- lib/lvmama-api/configuration.rb
+- lib/lvmama-api/connection.rb
+- lib/lvmama-api/error.rb
+- lib/lvmama-api/request.rb
+- lib/lvmama-api/version.rb
+- lvmama-api.gemspec
+homepage: https://github.com/tzwm/lvmama-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Lvmama API
+test_files: []