steam_tracks 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62587f04c4db0e095aa776da2f98a2ac19d74d2c
-  data.tar.gz: fa42703c211e9288bf7d6ec1c63f8cf0a11a46d9
+  metadata.gz: a41170ce490dba09f17e1978bbb0ea5c67103554
+  data.tar.gz: 36744e7f38e87aa8be87a0a82b3ced3b4bd4d8a7
 SHA512:
-  metadata.gz: aca10c4ca8433f72e2dd139f0a4c3c912e661c34dcf1ac101738faf3f226132c80f9f3620f9790f76b36a8386fb8f0c5319471ebd17c014e9993d7b396424ddd
-  data.tar.gz: c58454f0ed2c9b725ca75d849af63862f4946cb77d294dcd587824c2e154ebbb7ddeda65103336ce5840d1dc7cfc46e794d044b77249482638126977f48af1c5
+  metadata.gz: 7265e10cc5673e94168f68f0ac552cf6b5d8f59dd4c859ddd98311f9d48fa29515baa5da2f35477d4a983331548591b6e431378be4c28f3681a1f840823ef9bd
+  data.tar.gz: a924df29d0aca99aac83df7dbc425d249406906477870f29b58e81aeebf9e419aec934a9a6f0eb1c0588057e12e6e7aa0e4dc1000476518fdbecc6b27198c8df

data/.gitignore

@@ -0,0 +1,19 @@
+/.idea
+test.rb
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bontscho
+
+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,31 @@
+# SteamTracks
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'steam_tracks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steam_tracks
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/steam_tracks/fork )
+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
+=======
+steamtracks-ruby

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/steam_tracks.rb

@@ -1,5 +1,27 @@
-class SteamTracks
-  def self.hi
-    puts "Hello World!"
+require 'active_support/core_ext/module/attribute_accessors'
+require_relative "steam_tracks/version"
+require_relative "steam_tracks/base"
+
+module SteamTracks
+  mattr_accessor :api_key, :api_secret, :api_version, :api_base, :steamtracks_base
+  @@api_key = nil
+  @@api_secret = nil
+  @@api_version = 1
+  @@api_base = "https://steamtracks.com/api"
+  @@steamtracks_base = "https://steamtracks.com"
+
+  def self.setup
+    yield self if block_given?
   end
-end
+
+  # redirect all request to corresponding api version module
+  def self.method_missing(m, *args, &block)
+    receiver = Kernel.const_get("SteamTracks::Api::V" + self.api_version.to_s)
+
+    if receiver.respond_to?(m.to_sym)
+      receiver.send(m, *args)
+    else
+      super
+    end
+  end
+end

data/lib/steam_tracks/api.rb

@@ -0,0 +1,7 @@
+module SteamTracks
+  module Api
+    mattr_reader :versions
+    # all available api versions
+    @@versions = [ 1 ]
+  end
+end

data/lib/steam_tracks/api/v1.rb

@@ -0,0 +1,11 @@
+require_relative "v1/signup"
+require_relative "v1/request"
+require_relative "v1/users"
+require_relative "v1/notify"
+
+module SteamTracks
+  module Api
+    class V1
+    end
+  end
+end

data/lib/steam_tracks/api/v1/notify.rb

@@ -0,0 +1,9 @@
+module SteamTracks
+  module Api
+    class V1
+      def self.notify(options = {})
+        self.request :post, "notify", options
+      end
+    end
+  end
+end

data/lib/steam_tracks/api/v1/request.rb

@@ -0,0 +1,51 @@
+require 'uri'
+require 'base64'
+require 'openssl'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module SteamTracks
+  module Api
+    class V1
+      def self.request method, resource, params = {}
+        url = "#{SteamTracks.api_base}/v#{SteamTracks.api_version}/#{resource}"
+
+        # add time param for security
+        params[:t] = Time.now.to_i
+
+        uri = URI.parse(url)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+
+        request = nil
+        payload = params.to_json
+        signature = Base64.encode64(OpenSSL::HMAC.digest('sha1', SteamTracks.api_secret, payload))
+
+        if method == :get
+          request = Net::HTTP::Get.new(uri, { 'Content-Type' => 'application/json'})
+        elsif method == :post
+          request = Net::HTTP::Post.new(uri, { 'Content-Type' => 'application/json'})
+        else
+          raise "invalid request method"
+        end
+
+        request.body = payload
+
+        request["SteamTracks-Key"] = SteamTracks.api_key
+        request["SteamTracks-Signature"] = URI.encode(signature)
+        request["ACCEPT"] = "application/json"
+
+        response = https.request(request)
+
+        json = JSON(response.body)
+
+        if response.code.to_i != 200
+          raise json["error"]
+        end
+        return json["result"] if json.has_key?("result")
+        json
+      end
+    end
+  end
+end

data/lib/steam_tracks/api/v1/signup.rb

@@ -0,0 +1,29 @@
+module SteamTracks
+  module Api
+    class V1
+      def self.getSignupToken
+        result = self.request :get, "signup/token"
+        return result["token"] if result["token"]
+        nil
+      end
+
+      def self.getSignupURL(token = nil)
+        if token.nil?
+          token = self.getSignupToken
+        end
+        "#{SteamTracks.steamtracks_base}/appauth/#{token}"
+      end
+
+      def self.getSignupStatus(token)
+        result = self.request :get, "signup/status", { token: token }
+        return result
+      end
+
+      def self.ackSignup(token, user = nil)
+        data = { token: token }
+        data[:user] = user unless user.nil?
+        self.request :post, "signup/ack", data
+      end
+    end
+  end
+end

data/lib/steam_tracks/api/v1/users.rb

@@ -0,0 +1,41 @@
+module SteamTracks
+  module Api
+    class V1
+      def self.userStates
+        self.request :get, "users/states"
+      end
+
+      def self.userGames
+        self.request :get, "users/games"
+      end
+
+      def self.userInfo(user32)
+        self.request :get, "users/info", { user: user32 }
+      end
+
+      def self.userList(page = nil)
+        arguments = (page.nil? ? {} : {page: page})
+        self.request :get, "users", arguments
+      end
+
+      def self.userCount
+        self.request :get, "users/count"
+      end
+
+      def self.userLeavers
+        self.request :get, "users/leavers"
+      end
+
+      def self.userFlushLeavers
+        self.request :post, "users/flushleavers"
+      end
+
+      def self.userDelta(from_timestamp = nil, fields = [])
+        arguments = {}
+        arguments[:from_timestamp] = (from_timestamp.nil? ? 0 : from_timestamp.to_i)
+        arguments[:fields] = fields unless fields.count == 0
+        self.request :get, "users/delta", arguments
+      end
+    end
+  end
+end

data/lib/steam_tracks/base.rb

@@ -0,0 +1,2 @@
+require_relative "api"
+require_relative "api/v1"

data/lib/steam_tracks/version.rb

@@ -0,0 +1,3 @@
+module SteamTracks
+  VERSION = "0.1"
+end

data/steam_tracks.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam_tracks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "steam_tracks"
+  spec.version       = SteamTracks::VERSION
+  spec.authors       = ["bontscho"]
+  spec.email         = ["software@bontscho.de"]
+  spec.summary       = %q{Will come soon}
+  spec.description   = %q{Description will come soon too}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "active_support", "~> 3.1"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,23 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: steam_tracks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - bontscho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
-dependencies: []
-description: no description yet
-email: software@bontscho.de
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Description will come soon too
+email:
+- software@bontscho.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/steam_tracks.rb
-homepage: https://github.com/bontscho/steamtracks-ruby
+- lib/steam_tracks/api.rb
+- lib/steam_tracks/api/v1.rb
+- lib/steam_tracks/api/v1/notify.rb
+- lib/steam_tracks/api/v1/request.rb
+- lib/steam_tracks/api/v1/signup.rb
+- lib/steam_tracks/api/v1/users.rb
+- lib/steam_tracks/base.rb
+- lib/steam_tracks/version.rb
+- steam_tracks.gemspec
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -40,5 +98,5 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: no summary yet
+summary: Will come soon
 test_files: []