twitch-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2c0a000501b7f068e501cbd89d6768dd71d4953054f3e52f6b52e8a3ece44fe
-  data.tar.gz: 3f07b55c534c086fc20cec007b5b7b14c8aae6a70977ec488713a810462e4da5
+  metadata.gz: ac33cdb4eea079d0b42b33b7eabe032559a53a491e31ea89c0631820f1e0fcd4
+  data.tar.gz: e3dac26f11d2560eaed250cac580be1c4a9c260d2a2d2cd8fbd3db011eae1fba
 SHA512:
-  metadata.gz: 2ea4e22e642a68541f5a5fb10f5e6ea19d52c1b55ce6a55e302235d35dda22dd5db119a4fa9f576a4708f22b21edeb41d295a656d3341d77065e062e9093c2ee
-  data.tar.gz: eb52773a0b6c62c3082c344f2016fff660e1c8a0ebde4c6dccee16b042c2c5e8c924f3f2d40379307d8214d358eb54063a6caadee52531e849cb386ff45b4c68
+  metadata.gz: dbcfd386114ef19bd142faa9d768acff1dfe83adaa21fec029e7c3cc517ed664d7f24f7bcd112449ebf8eb9b2306f6727200a344064026ffabbda154ee848a6a
+  data.tar.gz: e40a2a3c7635ce58ab7b05a96b682b34e46549135e9874ec4ac7ad97088157acecfe18939b80c11ecaf9effe95179bef5b066e6154a7cfc8e42813c9bfcc28ba

data/README.md

@@ -19,20 +19,28 @@ Or install it yourself as:
     $ gem install twitch-api
 
 ## Usage
-The initially available methods take in a hash equal to the GET parameters of the API endpoint, and return an typed array of the items requested.
+NOTE: **These procedures are subject to change** while both the API and this library are in an early state.
+
+A client must be initialized with your client ID, and optionally an OAuth access token.
 ```
 client = Twitch::Client.new client_id: "YOUR_CLIENT_ID"
+```
+The retrieval methods take in a hash equal to the GET parameters of the API endpoint, and return an typed array of the items requested.
+```
 # Get top live streams
 client.get_streams
 # Get a single user
 client.get_users({login: "disguisedtoasths"}).first
+# Find some games
+# (use an array for up to 100 of most queryable resources)
+client.get_games({name: ["Heroes of the Storm", "Super Mario Odyssey"]})
 ```
 
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/twitch/client.rb

@@ -3,6 +3,8 @@ require "faraday_middleware"
 
 require "twitch/stream"
 require "twitch/user"
+require "twitch/game"
+require "twitch/video"
 
 module Twitch
   class Client
@@ -35,6 +37,18 @@ module Twitch
       users = res.body['data'].map { |u| User.new(u) }
     end
 
+    def get_games(options = {})
+      res = get('games', options)
+
+      games = res.body['data'].map { |g| Game.new(g) }
+    end
+
+    def get_videos(options = {})
+      res = get('videos', options)
+
+      videos = res.body['data'].map { |v| Video.new(v) }
+    end
+
     private
 
       def get(resource, params)

data/lib/twitch/game.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class Game
+    attr_reader :id, :name, :box_art_url
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/twitch/stream.rb

@@ -1,10 +1,17 @@
+require "time"
+
 module Twitch
   class Stream
     attr_reader :id, :user_id, :game_id, :community_ids, :type, :title, :viewer_count, :started_at, :language, :thumbnail_url
-    
+    DATE_ATTRIBUTES = [:started_at]
+
     def initialize(attributes = {})
       attributes.each do |k, v|
-        instance_variable_set("@#{k}", v)
+        if DATE_ATTRIBUTES.include?(k.to_sym)
+          instance_variable_set("@#{k}", Time.parse(v))
+        else
+          instance_variable_set("@#{k}", v)
+        end
       end
     end
   end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/twitch/video.rb

@@ -0,0 +1,19 @@
+require "time"
+
+module Twitch
+  class Video
+    DATE_ATTRIBUTES = [:created_at, :published_at]
+
+    attr_reader :id, :title, :description, :language, :view_count, :created_at, :published_at, :thumbnail_url
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        if DATE_ATTRIBUTES.include?(k.to_sym)
+          instance_variable_set("@#{k}", Time.parse(v))
+        else
+          instance_variable_set("@#{k}", v)
+        end
+      end
+    end
+  end
+end

data/twitch-api.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby client for the Twitch Helix API.}
   spec.homepage      = "https://github.com/mauricew/ruby-twitch-api"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Maurice Wahba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,9 +98,11 @@ files:
 - bin/setup
 - lib/twitch-api.rb
 - lib/twitch/client.rb
+- lib/twitch/game.rb
 - lib/twitch/stream.rb
 - lib/twitch/user.rb
 - lib/twitch/version.rb
+- lib/twitch/video.rb
 - twitch-api.gemspec
 homepage: https://github.com/mauricew/ruby-twitch-api
 licenses:
@@ -114,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="