twitchrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6d24ae98033340c3a32007d15326393e2eb630d9bf617a22dcd86c3bd96205b
+  data.tar.gz: 4099ce7790604f9d77dfb4e7e5c22252573ef6adcfde1806b99ea8b966d984cf
+SHA512:
+  metadata.gz: 63a0c047cd6803daf0e094bdf88e0fb6ac73fa1959beb84f43c38634190bb5a53ce2e2242993ead65b8361ca4673a601a608a7769eac4026c320b83f9e57a3cc
+  data.tar.gz: c04701b41259897d3a871df91037b801fb6c36f3e15f8bb764863dc96435b1da5671a97611570e11f5244d94dc851275f1f7cf0b4a69dcd929822548d2061157

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twitch.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    twitchrb (0.1.0)
+      httparty (~> 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  twitchrb!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dean Perry
+
+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,29 @@
+# TwitchRB
+
+**This library is a work in progress**
+
+This RubyGem is a library for intereacting with the Twitch API.
+
+It will allow you to easily interact with both the Kraken and Helix APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "twitchrb", require: "twitch"
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/twitchrb.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twitch"
+
+# 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.rb

@@ -0,0 +1,37 @@
+require "time"
+require "httparty"
+require "json"
+
+require "twitch/version"
+
+require "twitch/client"
+require "twitch/initializable"
+
+# Kraken (v5) API
+require "twitch/kraken/user"
+require "twitch/kraken/users"
+require "twitch/kraken/channels"
+require "twitch/kraken/clips"
+
+module Twitch
+
+  class << self
+    attr_reader :client
+
+    def access_details(client_id)
+      @client = Client.new(client_id)
+      # @client.access_token = access_token if access_token
+    end
+  end
+
+  # Error classes to raise
+  class Error < StandardError; end
+  module Errors
+    class ServiceUnavailable < Error; end
+    class AccessDenied < Error; end
+    class NotFound < Error; end
+    class CommunicationError < Error; end
+    class ValidationError < Error; end
+  end
+
+end

data/lib/twitch/client.rb

@@ -0,0 +1,89 @@
+require "httparty"
+
+module Twitch
+  class Client
+
+    # def initialize(client_id, client_secret, access_token=nil)
+    def initialize(client_id)
+      puts "initialize"
+
+      @client_id = client_id
+
+      # if client_id && client_secret
+      #   @client_id = client_id
+      #   @client_secret = client_secret
+      #   @access_token = access_token
+      # else
+      #   raise Twitch::ClientError.new('Client ID or Client Secret not set')
+      # end
+
+    end
+
+
+    def get(kind, url, params={})
+      # puts url
+      # puts params
+      # puts @client_id
+      response = HTTParty.get("https://api.twitch.tv/#{kind}/#{url}", {
+        headers: {
+          "Client-ID" => @client_id,
+          "Accept" => "application/vnd.twitchtv.v5+json",
+          # "Authorization" => "OAuth #{@access_token}"
+        }
+      })
+      # puts response
+
+      # JSON.parse(response.body)
+
+      success = case response.code
+      when 200
+        JSON.parse(response.body)
+      when 400
+        json = JSON.parse(response.body)
+        raise Twitch::Errors::NotFound, json['error']
+      when 503
+        raise Twitch::Errors::ServiceUnavailable
+      when 401, 403
+        puts response.body.inspect
+        raise Twitch::Errors::AccessDenied, "Access Denied for '#{@client_id}'"
+      when 400
+        json = JSON.parse(response.body)
+        raise Twitch::Errors::ValidationError, json['errors'].to_s
+      else
+        raise Twitch::Errors::CommunicationError, response.body
+      end
+
+
+      # if response.code == 200
+      #   JSON.parse(response.body)
+      # elsif response.code == 404
+      #   Twitch::NotFoundError.new(response.body)
+      # elsif response.code == 500
+      #   Twitch::ServerError.new(response.body)
+      # end
+
+
+
+      # when Net::HTTPClientError
+      #   json = JSON.parse(http_result.body)
+      #   raise Twitch::Errors::ValidationError, json['errors'].to_s
+      # else
+      #   raise Twitch::Errors::CommunicationError, http_result.body
+      # end
+
+
+    end
+
+
+    # private
+
+    # def request(method, path, options={})
+    #   # if @access_token
+
+
+
+    # end
+
+
+  end
+end

data/lib/twitch/initializable.rb

@@ -0,0 +1,16 @@
+module Twitch
+  module Initializable
+
+    def initialize(params = {})
+      params.each do |key, value|
+        if key == "_id"
+          key = "id"
+        end
+
+        setter = "#{key}="
+        send(setter, value) if respond_to?(setter.to_sym, false)
+      end
+
+    end
+  end
+end

data/lib/twitch/kraken/channels.rb

@@ -0,0 +1,22 @@
+module Twitch
+  module Kraken
+    class Channels
+
+      include Initializable
+
+      attr_accessor :id, :name, :display_name, :broadcaster_language, :followers, :game, :language, :logo, :mature, :partner, :profile_banner, :profile_banner_background_colour, :status, :url, :video_banner, :views, :created_at, :updated_at
+
+      class << self
+
+        # Gets a specified channel object
+        def get_channel_by_id(id)
+          response = Twitch.client.get(:kraken, "channels/#{id}")
+
+          new(response)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/twitch/kraken/clips.rb

@@ -0,0 +1,22 @@
+module Twitch
+  module Kraken
+    class Clips
+
+      include Initializable
+
+      attr_accessor :id, :title, :slug, :url, :embed_url, :game, :views, :duration, :language, :broadcaster, :curator, :vod, :created_at, :updated_at
+
+      class << self
+
+        # Gets details about a specified clip
+        def get(slug)
+          response = Twitch.client.get(:kraken, "clips/#{slug}")
+
+          new(response)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/twitch/kraken/user.rb

@@ -0,0 +1,23 @@
+module Twitch
+  module Kraken
+    class User
+
+      include Initializable
+
+      attr_accessor :id, :name, :display_name, :email, :email_verified, :partnered, :type, :bio, :logo, :created_at, :updated_at
+
+      class << self
+
+        # Gets a user object based on the OAuth token provided
+        # Scopes required: user_read
+        def get
+          response = Twitch.client.get("user")
+
+          new(response)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/twitch/kraken/users.rb

@@ -0,0 +1,33 @@
+module Twitch
+  module Kraken
+    class Users
+
+      include Initializable
+
+      attr_accessor :id, :name, :display_name, :type, :bio, :logo, :created_at, :updated_at
+
+      class << self
+
+        # Gets a specified user object
+        def get_user_by_id(id)
+          response = Twitch.client.get(:kraken, "users/#{id}")
+
+          new(response)
+        end
+
+        # Gets the user objects for the specified Twitch login names
+        def get_users(username)
+          response = Twitch.client.get(:kraken, "users?login=#{username}")
+
+          if response["users"].count >= 1
+            new(response["users"].first)
+          else
+            raise Twitch::Errors::NotFound
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/twitch/version.rb

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

data/twitchrb.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/twitch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twitchrb"
+  spec.version       = Twitch::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for interacting with the Twitch API"
+  spec.homepage      = "https://twitchrb.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/twitchrb"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "httparty", "~> 0.18.1"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: twitchrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitch.rb
+- lib/twitch/client.rb
+- lib/twitch/initializable.rb
+- lib/twitch/kraken/channels.rb
+- lib/twitch/kraken/clips.rb
+- lib/twitch/kraken/user.rb
+- lib/twitch/kraken/users.rb
+- lib/twitch/version.rb
+- twitchrb.gemspec
+homepage: https://twitchrb.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://twitchrb.com
+  source_code_uri: https://github.com/deanpcmad/twitchrb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby library for interacting with the Twitch API
+test_files: []