gamewisp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf0aa20633ea9cea62bff4ece38954eea39a1768
+  data.tar.gz: e7c93437b6309b8c3b09c82cd10f3c8db3b49a82
+SHA512:
+  metadata.gz: a6c4168986a17cbe9ba362e36f80afe67fac79f38a4a9a2d2c5ab7f147860c474c3b079ac5e8e58091cbf2d52013290e15417690ab7be575ae8a4a7b45b3fefc
+  data.tar.gz: 6288cb3d946cc481adfabfe9742487d1c69bbf27a9468f47147bb3bb06bf05744a3abf05b0d306990f498e9827204c9bc9424b235b5708081b352b29a3071c46

data/.gitignore

@@ -0,0 +1,35 @@
+# Gem build dir
+/pkg/
+
+# Rspec/testing files
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+.envsetup
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/coverage/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+/.bin/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Jeff McAffee
+
+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,72 @@
+# Gamewisp
+
+A ruby Gamewisp API library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gamewisp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamewisp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Testing
+
+`guard` is supported for testing submon.
+
+To successfully run the gamewisp tests, you'll need your gamewisp API key.
+Create a file named `.envsetup` in the project root containing the following:
+
+    #!/bin/bash
+    # vi: ft=shell
+
+    export GAMEWISP_APP=YOUR APP NAME HERE
+    export GAMEWISP_ID=YOUR ID HERE
+    export GAMEWISP_SECRET=YOUR SECRET HERE
+    export GAMEWISP_ENDPOINT_HOST=localhost
+    export GAMEWISP_ENDPOINT_PORT=8080
+
+Replace `YOUR * HERE` with your values and save it.
+
+Before running tests, in the terminal you'll start the tests from,
+source `.envsetup` file, then run your tests.
+The tests will look for the API key in the environment variables.
+
+    $ source ./.envsetup
+    $ bundle exec rspec
+
+Or, if using guard:
+
+    $ source ./.envsetup
+    $ bundle exec guard
+
+`.envsetup` is ignored in `.gitignore` so you don't have to worry about your
+API key getting uploaded/committed to the repo.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmcaffee/gamewisp.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gamewisp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+def client
+  @client ||= Gamewisp::Client.new
+end
+
+def get_auth
+  client.authorize
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+#require "irb"
+#IRB.start
+#
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gamewisp.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamewisp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gamewisp"
+  spec.version       = Gamewisp::VERSION
+  spec.authors       = ["Jeff McAffee"]
+  spec.email         = ["jeff@ktechsystems.com"]
+
+  spec.summary       = %q{GameWisp API ruby library}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/jmcaffee/gamewisp"
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "oauth2", "~> 1.2"
+  spec.add_dependency "httparty"
+  spec.add_dependency "json", "~> 2.0"
+end

data/lib/gamewisp.rb

@@ -0,0 +1,25 @@
+require "gamewisp/version"
+
+module Gamewisp
+  class GamewispClientError < StandardError
+  end
+end
+
+if ENV["DEBUG"] and ENV["DEBUG"] == "1"
+  $DEBUG = true
+end
+
+def dbg msg, other = nil
+  if $DEBUG
+    puts msg
+    unless other.nil?
+      puts other
+    end
+  end
+end
+
+require 'gamewisp/token_store'
+require 'gamewisp/authorizer'
+require 'gamewisp/server'
+require 'gamewisp/client'
+

data/lib/gamewisp/authorizer.rb

@@ -0,0 +1,128 @@
+##############################################################################
+# File::    authorizer.rb
+# Purpose:: Gamewisp OAuth Authorizer
+# 
+# Author::    Jeff McAffee 11/07/2016
+# Copyright:: Copyright (c) 2016, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'json/pure'
+require 'httparty'
+
+module Gamewisp
+  class Authorizer
+
+    attr_accessor :token_store
+    attr_accessor :gamewisp_url
+    attr_accessor :authorize_path
+    attr_accessor :redirect_uri
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :scopes
+    attr_accessor :state
+
+
+    # Only works if this class is derived (includes) HTTParty
+    #
+    #if ENV["DEBUG"]
+    #  debug_output $stdout
+    #end
+
+    def initialize state, store
+      self.token_store = store
+
+      self.gamewisp_url = 'api.gamewisp.com'
+      self.authorize_path = "/pub/v1/oauth/authorize"
+      self.host = token_store.endpoint_host
+      self.port = token_store.endpoint_port
+      self.redirect_uri = "http://#{host}:#{port}"
+
+      self.scopes = "read_only,subscriber_read_full,user_read"
+      self.state = state
+    end
+
+    def app_authorization_url
+      params = {
+        response_type: "code",
+        client_id: token_store.client_id,
+        redirect_uri: redirect_uri,
+        scope: scopes,
+        state: state,
+      }
+
+      url = {
+        host: gamewisp_url,
+        path: authorize_path,
+        query: URI.encode_www_form(params)
+      }
+
+      return URI::HTTPS.build(url)
+    end
+
+    def create_server_instance
+      return Server.new(port, state)
+    end
+
+    def renew_tokens_with_auth_code code
+      response = get_new_tokens_using_auth_code code
+      dbg("renew_tokens_with_auth_code", response)
+      if response.code == 200
+        token_store.save_access_token response["access_token"]
+        token_store.save_refresh_token response["refresh_token"]
+      else
+        puts "Errors have occured during authentication code request:"
+        puts response
+      end
+    end
+
+    def renew_tokens_with_refresh_token token
+      response = get_new_tokens_using_refresh_token token
+      dbg("renew_tokens_with_refresh_token", response)
+      if response.code == 200
+        token_store.save_access_token response["access_token"]
+        token_store.save_refresh_token response["refresh_token"]
+      else
+        puts "Errors have occured during token refresh request:"
+        puts response
+      end
+    end
+
+    def get_new_tokens_using_auth_code code
+      url = "https://#{gamewisp_url}/pub/v1/oauth/token"
+
+      response = HTTParty.post(url,
+                  :query => {
+                    :grant_type => 'authorization_code',
+                    :client_id => token_store.client_id,
+                    :client_secret => token_store.client_secret,
+                    :redirect_uri => redirect_uri,
+                    :code => code,
+                    :state => state,
+                  })
+      return {:error => "#{response.code}: authorization error"} if response.code == 401
+
+      return response
+    end
+
+    def get_new_tokens_using_refresh_token token
+      url = "https://#{gamewisp_url}/pub/v1/oauth/token"
+
+      # For some reason we have to post in the :body instead of :query (as above) or we'll
+      # get an 'invalid refresh token' error response.
+      #
+      response = HTTParty.post(url,
+                  :body => {
+                    :grant_type => 'refresh_token',
+                    :client_id => token_store.client_id,
+                    :client_secret => token_store.client_secret,
+                    :redirect_uri => redirect_uri,
+                    :refresh_token => token,
+                  })
+
+      return {:error => "#{response.code}: authorization error"} if response.code == 401
+
+      return response
+    end
+  end
+end # module

data/lib/gamewisp/client.rb

@@ -0,0 +1,76 @@
+##############################################################################
+# File::    client.rb
+# Purpose:: Gamewisp API client library
+# 
+# Author::    Jeff McAffee 11/07/2016
+# Copyright:: Copyright (c) 2016, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'json/pure'
+require 'httparty'
+
+module Gamewisp
+  class Client
+
+    attr_accessor :token_store
+    attr_accessor :auth
+
+
+    # Only works if this class is derived (includes) HTTParty
+    #
+    #if ENV["DEBUG"]
+    #  debug_output $stdout
+    #end
+
+    def initialize
+      self.token_store = TokenStore.new
+      self.auth = Authorizer.new 'createauth', self.token_store
+    end
+
+    def authorize
+      puts "Visit the following URL in your browser and authorize #{token_store.app_name} to access your subscription metrics"
+      puts "   #{auth.app_authorization_url}"
+      puts
+
+      server = auth.create_server_instance
+      auth_result = server.get_authentication_token
+
+      puts auth_result
+      if auth_result["code"]
+        puts "Authorization received"
+      else
+        raise GamewispError, "Authorization failed."
+      end
+
+      auth.renew_tokens_with_auth_code auth_result["code"]
+    end
+
+    def renew_access_token
+      if token_store.refresh_token.nil? || token_store.refresh_token.empty?
+        return authorize
+      end
+
+      auth.renew_tokens_with_refresh_token token_store.refresh_token
+    end
+
+    def get_subscribers
+      url = "https://api.gamewisp.com/pub/v1/channel/subscribers"
+
+      dbg "Client.get_subscribers [access_token]", token_store.access_token
+
+      response = HTTParty
+        .get(url,
+            :query => {
+              :access_token => token_store.access_token,
+              :include => 'user,channel,benefits',
+            }
+          )
+
+      dbg "Client.get_subscribers [response.code]", response.code
+      dbg "Client.get_subscribers [response]", response
+
+      response
+    end
+  end
+end # module

data/lib/gamewisp/server.rb

@@ -0,0 +1,82 @@
+##############################################################################
+# File::    server.rb
+# Purpose:: Simple server to collect authentication token
+# 
+# Author::    Jeff McAffee 11/07/2016
+# Copyright:: Copyright (c) 2016, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'socket'
+
+module Gamewisp
+  class Server
+
+    attr_reader :port
+    attr_reader :state
+
+    def initialize port, state
+      @port = port
+      @state = state
+    end
+
+    def get_authentication_token
+      raise ArgumentError, "No port specified" if port.nil?
+      raise ArgumentError, "No state specified" if state.nil?
+
+      server = TCPServer.open(port) # Socket to listen on specific port
+
+      client = server.accept
+      method, path = client.gets.split
+      headers = {}
+      while line = client.gets.split(" ", 2)
+        break if line[0] == ""
+        headers[line[0].chop] = line[1].strip
+      end
+      data = client.read(headers["Content-Length"].to_i)
+
+      dbg "Server:get_authentication_token [method]", method
+      dbg "Server:get_authentication_token [path]", path
+      dbg "Server:get_authentication_token [headers]", headers
+      dbg "Server:get_authentication_token [data]", data
+
+      results = split_path_components path
+
+      failed = false
+
+      if results["state"].nil? || results["state"] != @state
+        client.puts "Unrecognized request. Please try again"
+        failed = true
+      end
+
+      if results["code"].nil?
+        client.puts "Unrecognized request. Please try again"
+        failed = true
+      end
+
+      unless failed == true
+        client.puts "Authorization received. You can close this window now."
+      end
+
+      client.close
+
+      results
+    end
+
+    def split_path_components path
+      raise ArgumentError, "nil path returned from gamewisp" if path.nil?
+
+      vals = path.split('&', 2)
+      vals[0].gsub!("/?", "")
+
+      results = {}
+      parts = vals[0].split("=", 2)
+      results[parts[0]] = parts[1]
+
+      parts = vals[1].split("=", 2)
+      results[parts[0]] = parts[1]
+
+      results
+    end
+  end
+end

data/lib/gamewisp/token_store.rb

@@ -0,0 +1,87 @@
+##############################################################################
+# File::    token_store.rb
+# Purpose:: Store Gamewisp OAuth Tokens and authenication info
+# 
+# Author::    Jeff McAffee 11/07/2016
+# Copyright:: Copyright (c) 2016, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+module Gamewisp
+  class TokenStore
+
+    def initialize
+      @tokens = {
+        :access_token => '',
+        :refresh_token => '',
+      }
+
+      read_token_file
+    end
+
+    def client_id
+      ENV["GAMEWISP_ID"]
+    end
+
+    def client_secret
+      ENV["GAMEWISP_SECRET"]
+    end
+
+    def app_name
+      ENV["GAMEWISP_APP"]
+    end
+
+    def endpoint_host
+      ENV["GAMEWISP_ENDPOINT_HOST"]
+    end
+
+    def endpoint_port
+      ENV["GAMEWISP_ENDPOINT_PORT"]
+    end
+
+    def save_access_token token
+      @tokens[:access_token] = token
+      write_token_file
+    end
+
+    def save_refresh_token token
+      @tokens[:refresh_token] = token
+      write_token_file
+    end
+
+    def access_token
+      @tokens[:access_token]
+    end
+
+    def refresh_token
+      @tokens[:refresh_token]
+    end
+
+    def token_file_path
+      filedir = "#{ENV['HOME']}/.gamewisp"
+      filepath = File.join(filedir, "tokens.yml")
+
+      unless File.exist?(filedir)
+        FileUtils.mkdir_p filedir
+      end
+
+      filepath
+    end
+
+    def write_token_file
+      filepath = token_file_path
+
+      File.open(filepath, 'w') do |out|
+        YAML.dump(@tokens, out)
+      end
+    end
+
+    def read_token_file
+      filepath = token_file_path
+
+      if File.exist? filepath
+        @tokens = YAML.load_file(filepath)
+      end
+    end
+  end
+end

data/lib/gamewisp/version.rb

@@ -0,0 +1,3 @@
+module Gamewisp
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: gamewisp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff McAffee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: GameWisp API ruby library
+email:
+- jeff@ktechsystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gamewisp.gemspec
+- lib/gamewisp.rb
+- lib/gamewisp/authorizer.rb
+- lib/gamewisp/client.rb
+- lib/gamewisp/server.rb
+- lib/gamewisp/token_store.rb
+- lib/gamewisp/version.rb
+homepage: https://github.com/jmcaffee/gamewisp
+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.5.1
+signing_key: 
+specification_version: 4
+summary: GameWisp API ruby library
+test_files: []