opera-mobile-store-sdk 0.1.0

data/lib/opera/mobile_store_sdk/config.rb

@@ -0,0 +1,71 @@
+module Opera
+  module MobileStoreSDK
+    class Config
+
+      include ActiveSupport::Configurable
+
+      DEFAULT_API_URL = "https://publishers.apps.opera.com/administrator/mng_contpartners/export_partner_software.php".freeze
+
+      config_accessor :username do
+        ENV.fetch "OPERA_MOBILE_STORE_USERNAME", nil
+      end
+
+      config_accessor :password do
+        ENV.fetch "OPERA_MOBILE_STORE_PASSWORD", nil
+      end
+
+      # API host:
+      config_accessor :api_host do
+        api_uri = URI(ENV.fetch "OPERA_MOBILE_STORE_API_URL", DEFAULT_API_URL)
+        api_uri.path = ""
+        api_uri.to_s
+      end
+
+      # API path:
+      config_accessor :api_path do
+        api_uri = URI(ENV.fetch "OPERA_MOBILE_STORE_API_URL", DEFAULT_API_URL)
+        api_uri.path
+      end
+
+      # API Call Timeout:
+      config_accessor :api_call_timeout do
+        ENV.fetch("OPERA_MOBILE_STORE_API_CALL_TIMEOUT", 15).to_i
+      end
+
+      # API Call Open Timeout:
+      config_accessor :api_call_open_timeout do
+        ENV.fetch("OPERA_MOBILE_STORE_API_CALL_OPEN_TIMEOUT", 2).to_i
+      end
+
+      # Logger:
+      config_accessor :logger do
+        Logger.new($stdout)
+      end
+
+      # Authentication method:
+      config_accessor :authentication do
+        if ENV["OPERA_MOBILE_STORE_AUTH"].present?
+          ENV["OPERA_MOBILE_STORE_AUTH"].to_sym
+        else
+          :password
+        end
+      end
+
+      protected
+
+        # def auto_conf
+        #   # Cargar configuracion dentro del folder de config en Rails:
+        #   if defined?(Rails)
+        #     yml_path = File.join(Rails.root, 'config', 'narai.yml')
+        #     load_config_from_yml(yml_path, Rails.env)
+        #
+        #     # Use the Rails logger:
+        #     @logger = Rails.logger
+        #   elsif File.exists?('./narai.yml')
+        #     load_config_from_yml('./narai.yml')
+        #   end
+        # end
+
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/errors.rb

@@ -0,0 +1,10 @@
+module Opera
+  module MobileStoreSDK
+    module Errors
+
+      class APIParamsError < StandardError
+      end
+
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/faraday_middleware.rb

@@ -0,0 +1,4 @@
+require "opera/mobile_store_sdk/faraday_middleware/authentication"
+require "opera/mobile_store_sdk/faraday_middleware/required_response_format"
+require "opera/mobile_store_sdk/faraday_middleware/response_parser"
+require "opera/mobile_store_sdk/faraday_middleware/sdk_benchmark"

data/lib/opera/mobile_store_sdk/faraday_middleware/authentication.rb

@@ -0,0 +1,76 @@
+module Opera
+  module MobileStoreSDK
+    module FaradayMiddleware
+
+      # Adds the Opera Mobile Store Partner authentication parameters to the request
+      class Authentication < Faraday::Middleware
+
+        # Public: Initialize the middleware.
+        #
+        # app      - the Faraday app to wrap
+        # username - The Partner's username
+        # password - The Partner's username
+        # options  - (optional)
+        #            :authentication - (:password | :signature)
+        def initialize(app, username, password, options = {})
+          super(app)
+
+          @username, @password = username, password
+
+          options = options.with_indifferent_access
+
+          @authentication = if options.key?(:authentication) && [:password, :signature].include?(options[:authentication])
+            options[:authentication]
+          else
+            :signature
+          end
+        end
+
+        def call(env)
+
+          auth_params = { login: @username }
+
+          case @authentication
+          when :password then
+            auth_params[:pwd] = @password
+          else
+            auth_params[:sign] = get_signature(env)
+          end
+
+          # Add the generated params to the url query:
+          auth_query = auth_params.inject([]) { |arr, kv| arr + [kv.join('=')] }.join('&')
+          env.url.query = [auth_query, env.url.query].join('&')
+          
+          env[:url] = env.url
+
+          @app.call(env)
+        end
+
+        # Uses the partner password to generate the HMAC SHA1 key:
+        def signature_key
+          @_signature_key ||= [@password].pack("H*")
+        end
+
+        # Generates the required HMAC Hash using the request's GET params processed
+        # using Opera's "special algorithm":
+        def get_signature(env)
+
+          params_string = env.url.query.split('&').inject({}) do |hash, keyval|
+            key, val = keyval.split('=')
+            hash[key] = val
+            hash
+          end.except("login").sort.inject "" do |concatenated_string, keyval|
+            concatenated_string += keyval.map(&:downcase).join
+          end
+
+          # Return the SHA1 HMAC Hash:
+          OpenSSL::HMAC.hexdigest(
+            OpenSSL::Digest.new('sha1'), signature_key, params_string
+          )
+        end
+
+      end
+
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/faraday_middleware/required_response_format.rb

@@ -0,0 +1,14 @@
+module Opera
+  module MobileStoreSDK
+    module FaradayMiddleware
+      # Adds the required response format to the request parameters, in order for
+      # the SDK to work:
+      class RequiredResponseFormat < Faraday::Middleware
+        def call(env)
+          env.url.query = ["format=xml", env.url.query].join('&')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/faraday_middleware/response_parser.rb

@@ -0,0 +1,45 @@
+require "nokogiri"
+require "benchmark"
+
+module Opera
+  module MobileStoreSDK
+    module FaradayMiddleware
+      # Parses the responses to models:
+      class ResponseParser < Faraday::Middleware
+
+        def call(request_env)
+          # do something with the request
+          # request_env[:request_headers].merge!(...)
+
+          @app.call(request_env).on_complete do |response_env|
+
+            benchmark = Benchmark.measure "api_response_parsing" do
+              # Parse to XML:
+              xml_data = Nokogiri::XML(response_env[:body])
+
+              response_env[:found_rows] = xml_data.xpath("string(/xml/*/@found_rows)").to_i
+              response_env[:timestamp] = xml_data.xpath("string(/xml/*/@timestamp)").to_i
+
+              real_root_name = xml_data.xpath("name(/xml/*)")
+
+              parser_class = "Opera::MobileStore::#{real_root_name.classify}".safe_constantize
+
+              # Parse each node:
+              collection_path = "/xml/#{real_root_name}/#{real_root_name.singularize}"
+
+              parsed_data = xml_data.xpath(collection_path).map do |item_node|
+                parser_class.build_from_nokogiri_node item_node
+              end
+
+              # replace body with parsed_data:
+              response_env[:body] = parsed_data
+            end
+
+            response_env[:opera_api_response_parsing_tms] = benchmark
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/faraday_middleware/sdk_benchmark.rb

@@ -0,0 +1,47 @@
+require "benchmark"
+
+module Opera
+  module MobileStoreSDK
+    module FaradayMiddleware
+      # Parses the responses to models:
+      class SDKBenchmark < Faraday::Middleware
+
+        def call(request_env)
+
+          # Get the start times:
+          t0 = Process.times
+          r0 = if defined?(Benchmark::BENCHMARK_CLOCK)
+            Process.clock_gettime(Benchmark::BENCHMARK_CLOCK)
+          else
+            Time.now
+          end
+
+          @app.call(request_env).on_complete do |response_env|
+
+            response_env[:opera_api_response_datetime] = Time.parse(
+              response_env.response_headers["Date"]
+            )
+
+            # Get the finish times:
+            t1 = Process.times
+            r1 = if defined?(Benchmark::BENCHMARK_CLOCK)
+              Process.clock_gettime(Benchmark::BENCHMARK_CLOCK)
+            else
+              Time.now
+            end
+
+            response_env[:opera_api_calling_tms] = ::Benchmark::Tms.new(
+              t1.utime  - t0.utime,
+              t1.stime  - t0.stime,
+              t1.cutime - t0.cutime,
+              t1.cstime - t0.cstime,
+              r1 - r0,
+              "api_calling"
+            )
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/opera/mobile_store_sdk/identity_mapable.rb

@@ -0,0 +1,35 @@
+module Opera
+  module MobileStoreSDK
+    module IdentityMapable
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def identity_map
+          @_identity_map ||= {}
+        end
+
+        def find(given_id, hint_options = {})
+          if identity_map.key?(given_id)
+            identity_map[given_id]
+          else
+            raise "Not Implemented"
+          end
+        end
+
+        def registered?(object_id)
+          identity_map.key? object_id
+        end
+
+        def register(given_attributes)
+          obj = self.new given_attributes
+          identity_map[obj.id] = obj
+          identity_map[obj.id]
+        end
+
+      end
+
+    end
+  end
+end

data/opera-mobile-store-sdk.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opera-mobile-store-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opera-mobile-store-sdk"
+  spec.version       = Opera::MobileStoreSDK::VERSION
+  spec.authors       = ["Roberto Quintanilla"]
+  spec.email         = ["roberto.quintanilla@naranya.com"]
+
+  spec.summary       = %q{SDK for communicating with the Opera Mobile Store Publisher API}
+  spec.description   = %q{SDK for communicating with the Opera Mobile Store Publisher API.}
+  spec.homepage      = "http://www.example.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  #end
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "activemodel",   "~> 4.0"
+  spec.add_runtime_dependency "nokogiri",      "~> 1.6"
+  spec.add_runtime_dependency "faraday",       "~> 0.9"
+  spec.add_runtime_dependency "htmlentities",  "~> 4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake",    "~> 10.0"
+
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: opera-mobile-store-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roberto Quintanilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: SDK for communicating with the Opera Mobile Store Publisher API.
+email:
+- roberto.quintanilla@naranya.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opera-mobile-store-sdk.rb
+- lib/opera-mobile-store-sdk/version.rb
+- lib/opera/mobile_store/author.rb
+- lib/opera/mobile_store/build.rb
+- lib/opera/mobile_store/build_file.rb
+- lib/opera/mobile_store/category.rb
+- lib/opera/mobile_store/developer.rb
+- lib/opera/mobile_store/payment_info.rb
+- lib/opera/mobile_store/product.rb
+- lib/opera/mobile_store/product_image.rb
+- lib/opera/mobile_store/product_localization.rb
+- lib/opera/mobile_store_sdk/api_accessible.rb
+- lib/opera/mobile_store_sdk/api_object_list.rb
+- lib/opera/mobile_store_sdk/config.rb
+- lib/opera/mobile_store_sdk/errors.rb
+- lib/opera/mobile_store_sdk/faraday_middleware.rb
+- lib/opera/mobile_store_sdk/faraday_middleware/authentication.rb
+- lib/opera/mobile_store_sdk/faraday_middleware/required_response_format.rb
+- lib/opera/mobile_store_sdk/faraday_middleware/response_parser.rb
+- lib/opera/mobile_store_sdk/faraday_middleware/sdk_benchmark.rb
+- lib/opera/mobile_store_sdk/identity_mapable.rb
+- opera-mobile-store-sdk.gemspec
+homepage: http://www.example.com
+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.5
+signing_key: 
+specification_version: 4
+summary: SDK for communicating with the Opera Mobile Store Publisher API
+test_files: []