twitch-api 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# 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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in twitch-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Maurice Wahba
+
+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,43 @@
+# Ruby Twitch API (work in progress)
+
+This library is a Ruby implementation of the [Twitch Helix API](https://dev.twitch.tv/docs/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitch-api'
+```
+
+And then execute:
+
+    $ bundle
+
+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.
+```
+client = Twitch::Client.new client_id: "YOUR_CLIENT_ID"
+# Get top live streams
+client.get_streams
+# Get a single user
+client.get_users({login: "disguisedtoasths"}).first
+```
+
+## 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).
+
+## Contributing
+
+Upon reaching version 0.1.0, bug reports and pull requests will be welcome on GitHub at https://github.com/mauricew/ruby-twitch-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twitch-api"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/twitch-api.rb

@@ -0,0 +1,5 @@
+require "twitch/version"
+require "twitch/client"
+
+module Twitch
+end

data/lib/twitch/client.rb

@@ -0,0 +1,54 @@
+require "faraday"
+require "faraday_middleware"
+
+require "twitch/stream"
+require "twitch/user"
+
+module Twitch
+  class Client
+    API_ENDPOINT = "https://api.twitch.tv/helix".freeze
+
+    def initialize(client_id:, access_token: nil)
+      headers = {
+        "Client-ID": client_id,
+        "User-Agent": "twitch-api ruby client #{Twitch::VERSION}"
+      }
+      unless access_token.nil?
+        headers["Authorization"] = "Bearer #{access_token}"
+      end
+      
+      @conn = Faraday.new(API_ENDPOINT, { headers: headers }) do |faraday|
+        faraday.response :json
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def get_streams(options = {})
+      res = get('streams', options)
+
+      streams = res.body['data'].map { |s| Stream.new(s) }
+    end
+
+    def get_users(options = {})
+      res = get('users', options)
+
+      users = res.body['data'].map { |u| User.new(u) }
+    end
+
+    private
+
+      def get(resource, params)
+        res = @conn.get(resource, params)
+
+        unless res.status == 200
+          msg= %Q{The server returned an error.
+#{res.body["error"]}: #{res.body["message"]}
+Status: #{res.body["status"]}}
+
+          raise Exception.new(msg)
+        end
+
+        res
+      end
+  end
+end

data/lib/twitch/stream.rb

@@ -0,0 +1,11 @@
+module Twitch
+  class Stream
+    attr_reader :id, :user_id, :game_id, :community_ids, :type, :title, :viewer_count, :started_at, :language, :thumbnail_url
+    
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/twitch/user.rb

@@ -0,0 +1,12 @@
+module Twitch
+  class User
+    # All fields are read-only until update support is implemented
+    attr_reader :id, :login, :display_name, :type, :broadcaster_type, :description, :profile_image_url, :offline_image_url, :view_count
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/twitch/version.rb

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

data/twitch-api.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twitch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twitch-api"
+  spec.version       = Twitch::VERSION
+  spec.authors       = ["Maurice Wahba"]
+  spec.email         = ["maurice.wahba@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the Twitch Helix API.}
+  spec.homepage      = "https://github.com/mauricew/ruby-twitch-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.13"
+  spec.add_dependency "faraday_middleware", "~> 0.12"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: twitch-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maurice Wahba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- maurice.wahba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitch-api.rb
+- lib/twitch/client.rb
+- lib/twitch/stream.rb
+- lib/twitch/user.rb
+- lib/twitch/version.rb
+- twitch-api.gemspec
+homepage: https://github.com/mauricew/ruby-twitch-api
+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.7.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Twitch Helix API.
+test_files: []