openkit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d0b4f00b8e5a5a3a6ce085a3738719f3ac02265
+  data.tar.gz: d1b034360fe320cdf1ad7e538d5ccd29698fc01f
+SHA512:
+  metadata.gz: c2367135097d83e600d8f254d0ab7ae35916e11ad6223f03b3fb58134327cada781850c72898c350415159b38000933b6c87e3a000c96463fdf2149be5c76705
+  data.tar.gz: 9c325267738058087290d47b9f16030c1316f57e6fa631867baa6f32b43e477f2db20c105b85169b2989866247aca759b9e3cc380c34c07713e9086fc4c5d11b

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openkit.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lou Zell
+
+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,63 @@
+# Openkit
+
+The ruby client for OpenKit's gaming backend.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'openkit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openkit
+
+## Usage
+
+Get your app_key and secret_key from [https://developer.openkit.io](https://developer.openkit.io).
+
+Set credentials:
+
+	OpenKit::Config.app_key = "<your-app-key>"
+	OpenKit::Config.secret_key = "<your-secret-key>"
+	OpenKit::Config.skip_https = true  # required unless you're using the beta-api endpoint
+
+Request examples:
+
+	include OpenKit::Request
+	
+	# Get
+	response = Get.new('/v1/leaderboards').perform
+	
+	# Post
+	response = Post.new('/v1/users', {:nick => 'lou'}).perform
+	
+	# Put
+	response = Put.new('/v1/users/:id', {:nick => 'lou z'}).perform
+	
+	# Multipart Post
+	upload = Upload.new('<param-name-of-upload>', '<path-to-file>')
+	req = OpenKit::PostMultipart.new('/v1/scores', {:score => {:value => 100}}, upload)
+	response = req.perform
+	
+Parse the response:
+	
+	json = JSON.parse(response.body)
+	
+Check the response headers:
+	
+	puts response.code
+	response.header.each { |h, v| puts "#{h}: #{v}" }
+
+
+## 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 "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/openkit.rb

@@ -0,0 +1,15 @@
+module OpenKit
+
+  class Config
+    @host = 'api.openkit.io'  # default
+    class << self
+      attr_accessor :app_key, :secret_key
+      attr_accessor :host
+      attr_accessor :skip_https
+    end
+  end
+end
+
+require_relative 'openkit/request'
+require_relative "openkit/version"
+

data/lib/openkit/request.rb

@@ -0,0 +1,17 @@
+require 'securerandom'
+require 'net/http'
+require 'net/http/post/multipart'
+require 'digest/hmac'
+require 'base64'
+require 'cgi'
+require 'json'
+require 'pp'
+
+require_relative 'request/base'
+require_relative 'request/base_delegate'
+require_relative 'request/get'
+require_relative 'request/put'
+require_relative 'request/delete'
+require_relative 'request/post'
+require_relative 'request/post_multipart'
+require_relative 'request/upload'

data/lib/openkit/request/base.rb

@@ -0,0 +1,72 @@
+module OpenKit
+  module Request
+
+    class Base
+      def initialize(verb, the_delegate)
+        raise "Don't instantiate me!" if abstract_class?
+
+        @delegate         = the_delegate
+        @nonce            = SecureRandom.uuid
+        @oauth_version    = '1.0'
+        @signature_method = 'HMAC-SHA1'
+        @timestamp        = Time.now.to_i
+        @verb             = verb
+      end
+
+      def perform
+        http = Net::HTTP.new(@delegate.uri.host, @delegate.uri.port)
+        http.use_ssl = (@delegate.scheme == 'https')
+        http.start do
+          response = http.request(self.net_request)
+          response
+        end
+      end
+
+      def net_request
+        net_request = @delegate.net_request()
+        net_request['Authorization'] = authorization_header
+        net_request
+      end
+
+      private
+      def authorization_header
+        %|OAuth oauth_consumer_key="#{@delegate.app_key}", oauth_nonce="#{@nonce}", oauth_signature="#{escape(signature)}", oauth_signature_method="#{@signature_method}", oauth_timestamp="#{@timestamp}", oauth_version="#{@oauth_version}"|
+      end
+
+      def signature
+        k = @delegate.secret_key + "&"
+        hmac = Digest::HMAC.digest(signature_base_string, k, Digest::SHA1)
+        Base64.encode64(hmac).chomp
+      end
+
+      def signature_base_string
+        [ @verb.to_s.upcase,
+          escape(@delegate.base_uri + @delegate.uri.path),
+          escape(params_string_for_signature)
+        ].join('&')
+      end
+
+      def params_string_for_signature
+        params_in_signature.sort_by{|k, _| k}.collect{ |k,v| k.to_s + '=' + v.to_s }.join("&")
+      end
+
+      def params_in_signature
+        {
+          oauth_consumer_key:       @delegate.app_key,
+          oauth_nonce:              @nonce,
+          oauth_signature_method:   @signature_method,
+          oauth_timestamp:          @timestamp,
+          oauth_version:            @oauth_version,
+        }
+      end
+
+      def escape(s)
+        CGI.escape(s)
+      end
+
+      def abstract_class?
+        self.class == Base
+      end
+    end
+  end
+end

data/lib/openkit/request/base_delegate.rb

@@ -0,0 +1,37 @@
+module OpenKit
+  module Request
+
+    class BaseDelegate
+      attr_reader :scheme, :host, :app_key, :secret_key
+      attr_reader :path
+
+      def initialize(path)
+        raise "Don't instantiate me!" if abstract_class?
+
+        raise "OpenKit::Config.host is not set." unless Config.host
+        raise "OpenKit::Config.app_key is not set." unless Config.app_key
+        raise "OpenKit::Config.secret_key is not set." unless Config.secret_key
+
+        @scheme     = Config.skip_https ? "http" : "https"
+        @host       = Config.host
+        @app_key    = Config.app_key
+        @secret_key = Config.secret_key
+
+        @path = path
+      end
+
+      def base_uri
+        @scheme + "://" + @host
+      end
+
+      def uri
+        @uri ||= URI(base_uri + @path)
+      end
+
+      private
+      def abstract_class?
+        self.class == BaseDelegate
+      end
+    end
+  end
+end

data/lib/openkit/request/delete.rb

@@ -0,0 +1,31 @@
+# Delete.from('/path')
+module OpenKit
+  module Request
+
+    class Delete < Base
+
+      def self.from(path)
+        new(path).perform
+      end
+
+      def initialize(path)
+        super :delete, DeleteDelegate.new(path)
+      end
+    end
+
+
+    class DeleteDelegate < BaseDelegate
+
+      def initialize(path)
+        super(path)
+      end
+
+      def net_request
+        req = Net::HTTP::Delete.new(uri.request_uri)
+        req['Content-Type'] = "application/json; charset=utf-8"
+        req['Accept'] = "application/json"
+        req
+      end
+    end
+  end
+end

data/lib/openkit/request/get.rb

@@ -0,0 +1,43 @@
+# Get.from('/path', {query_param1: 'foo'})
+module OpenKit
+  module Request
+
+    class Get < Base
+
+      def self.from(path, query_params = {})
+        new(path, query_params).perform
+      end
+
+      def initialize(path, query_params = {})
+        super :get, GetDelegate.new(path, query_params)
+        @query_params = query_params
+      end
+
+      def params_in_signature
+        super.merge(@query_params)
+      end
+    end
+
+
+    class GetDelegate < BaseDelegate
+      attr_accessor :query_params
+
+      def initialize(path, query_params)
+        super(path)
+        @query_params = query_params
+      end
+
+      def net_request
+        req = Net::HTTP::Get.new(uri.request_uri + "?" + params_to_query(@query_params))
+        req['Content-Type'] = "application/json; charset=utf-8"
+        req['Accept'] = "application/json"
+        req
+      end
+
+      def params_to_query(h)
+        return '' if h.empty?
+        h.collect { |k, v| "#{k.to_s}=#{v.to_s}" }.join('&')
+      end
+    end
+  end
+end

data/lib/openkit/request/post.rb

@@ -0,0 +1,33 @@
+# Post.to('/path', {param1: 'foo'})
+module OpenKit
+  module Request
+
+    class Post < Base
+
+      def self.to(path, req_params)
+        new(path, req_params).perform
+      end
+
+      def initialize(path, req_params)
+        super :post, PostDelegate.new(path, req_params)
+      end
+    end
+
+
+    class PostDelegate < BaseDelegate
+
+      def initialize(path, req_params)
+        super(path)
+        @req_params = req_params
+      end
+
+      def net_request
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req.set_body_internal(@req_params.to_json)
+        req['Content-Type'] = "application/json; charset=utf-8"
+        req['Accept'] = "application/json"
+        req
+      end
+    end
+  end
+end

data/lib/openkit/request/post_multipart.rb

@@ -0,0 +1,63 @@
+# upload = Upload.new('score[meta_doc]', 'path-to-file')
+# PostMultipart.to('/path', {param1: 'foo'}, upload)
+module OpenKit
+  module Request
+
+
+    class PostMultipart < Base
+      attr_reader :upload
+
+      def self.to(path, req_params, upload)
+        new(path, req_params, upload).perform
+      end
+
+      def initialize(path, req_params, upload)
+        super :post, PostMultipartDelegate.new(path, req_params, upload)
+        @upload = upload
+      end
+
+      def perform
+        response = super
+        @upload.close
+        response
+      end
+    end
+
+
+    class PostMultipartDelegate < BaseDelegate
+
+      def initialize(path, req_params, upload)
+        super(path)
+        @req_params = req_params
+        @upload = upload
+      end
+
+      def net_request
+        up_io = UploadIO.new(@upload.file, "application/octet-stream", "upload")
+        flat_params = flatten_params(@req_params)
+        req = Net::HTTP::Post::Multipart.new(uri.request_uri, flat_params.merge(@upload.param_name => up_io))
+        req['Accept'] = "application/json"
+        req
+      end
+
+      def flatten_params(parameters)
+        flattened = {}
+        flat_names(parameters, '') do |name,v|
+          flattened[name] = v
+        end
+        flattened
+      end
+
+      def flat_names(parameters, running = '', &block)
+        parameters.each do |k,v|
+          name = (running.length == 0) ? k.to_s : running + "[#{k}]"
+          if v.is_a?(Hash)
+            flat_names(v, name, &block)
+          else
+            yield name, v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openkit/request/put.rb

@@ -0,0 +1,33 @@
+# Put.to('/path', {param1: 'foo'})
+module OpenKit
+  module Request
+
+    class Put < Base
+
+      def self.to(path, req_params)
+        new(path, req_params).perform
+      end
+
+      def initialize(path, req_params)
+        super :put, PutDelegate.new(path, req_params)
+      end
+    end
+
+
+    class PutDelegate < BaseDelegate
+
+      def initialize(path, req_params)
+        super(path)
+        @req_params = req_params
+      end
+
+      def net_request
+        req = Net::HTTP::Put.new(uri.request_uri)
+        req.set_body_internal(@req_params.to_json)
+        req['Content-Type'] = "application/json; charset=utf-8"
+        req['Accept'] = "application/json"
+        req
+      end
+    end
+  end
+end

data/lib/openkit/request/upload.rb

@@ -0,0 +1,21 @@
+module OpenKit
+  module Request
+
+    class Upload
+      attr_accessor :param_name, :filepath
+
+      def initialize(param_name, filepath)
+        @param_name = param_name
+        @filepath = filepath
+      end
+
+      def file
+        @file ||= File.open(@filepath)
+      end
+
+      def close
+        @file.close if @file  # Use ivar directly, not the #file method.
+      end
+    end
+  end
+end

data/lib/openkit/version.rb

@@ -0,0 +1,3 @@
+module Openkit
+  VERSION = "0.0.1"
+end

data/openkit.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openkit"
+  spec.version       = Openkit::VERSION
+  spec.authors       = ["Lou Zell"]
+  spec.email         = ["lou@openkit.io"]
+  spec.description   = %q{List leaderboards, post scores, etc.}
+  spec.summary       = %q{Client for OpenKit's gaming backend}
+  spec.homepage      = "https://github.com/OpenKit/openkit-server/tree/development/clients/ruby"
+  spec.license       = "MIT"
+  spec.files = %w[
+    Gemfile
+    LICENSE.txt
+    README.md
+    Rakefile
+    lib/openkit.rb
+    lib/openkit/request/base.rb
+    lib/openkit/request/base_delegate.rb
+    lib/openkit/request/delete.rb
+    lib/openkit/request/get.rb
+    lib/openkit/request/post.rb
+    lib/openkit/request/post_multipart.rb
+    lib/openkit/request/put.rb
+    lib/openkit/request/upload.rb
+    lib/openkit/request.rb
+    lib/openkit/version.rb
+    test/api/score_api_test.rb
+    test/api/user_api_test.rb
+    test/test_helper.rb
+    openkit.gemspec
+  ]
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7"
+  spec.add_development_dependency "turn"
+
+  spec.add_dependency 'multipart-post'
+end

data/test/api/score_api_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper.rb'
+
+class ScoreApiTest < ApiTest
+  def setup
+    super
+    @leaderboard_id = 831
+    @user_id = 237492
+  end
+
+  def test_create
+    custom_id = random_alphanumeric(7)
+    nick = "guest-#{custom_id}"
+
+    request = Post.new '/v1/scores', {score: {user_id: @user_id, leaderboard_id: @leaderboard_id, value: 100}}
+    response = request.perform
+    assert response.code =~ /^20\d/,  "Got a return code of #{response.code}"
+
+    score = JSON.parse(response.body)
+    assert score['id']
+  end
+end
+

data/test/api/user_api_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper.rb'
+
+class UserApiTest < ApiTest
+  def test_create
+    custom_id = random_alphanumeric(7)
+    nick = "guest-#{custom_id}"
+
+    request = Post.new '/v1/users', {user: {custom_id: custom_id, nick: nick}}
+    response = request.perform
+    assert response.code =~ /^20\d/
+
+    user = JSON.parse(response.body)
+    assert user['id']
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'openkit'
+gem "minitest", '~>4.7'
+require 'minitest/autorun'
+require 'turn'
+#require 'debugger'
+
+class ApiTest < MiniTest::Unit::TestCase
+  include OpenKit::Request
+
+  def setup
+    OpenKit::Config.skip_https = true
+    OpenKit::Config.app_key    = '9c7FMNznXbQC4Pr4FHi5'
+    OpenKit::Config.secret_key = 'o2HdzSZg99jdmP4oi0LdiJwFPYG06gXvCGqNHeXG'
+  end
+
+  def random_alphanumeric(n)
+    Array.new(n){[*'0'..'9', *'a'..'z', *'A'..'Z'].sample}.join
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: openkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lou Zell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: List leaderboards, post scores, etc.
+email:
+- lou@openkit.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openkit.rb
+- lib/openkit/request/base.rb
+- lib/openkit/request/base_delegate.rb
+- lib/openkit/request/delete.rb
+- lib/openkit/request/get.rb
+- lib/openkit/request/post.rb
+- lib/openkit/request/post_multipart.rb
+- lib/openkit/request/put.rb
+- lib/openkit/request/upload.rb
+- lib/openkit/request.rb
+- lib/openkit/version.rb
+- test/api/score_api_test.rb
+- test/api/user_api_test.rb
+- test/test_helper.rb
+- openkit.gemspec
+homepage: https://github.com/OpenKit/openkit-server/tree/development/clients/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.1.11
+signing_key: 
+specification_version: 4
+summary: Client for OpenKit's gaming backend
+test_files:
+- test/api/score_api_test.rb
+- test/api/user_api_test.rb
+- test/test_helper.rb