japi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aef6040b8f468c6963822eb2313e611f54021e11
+  data.tar.gz: b1e032b9e2b438ef60d125b05a7ab0582e60ced0
+SHA512:
+  metadata.gz: 11e59b930bef6c06675d67cb188131884b32134cb26d0d373b3c37124e9df25ecffdce7a4d25b487d3f4b9943a169b37680dcc1e1634615cac3425dce2a91465
+  data.tar.gz: df01c55d167e0d6ef303fb44478aa13e862482197a74e0d34a1bd3804752e50bd5c3d40884f60e6052b8d441547d1a5165b79d4317f3a2fd27218a44d9df3540

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.1
+  - 2.1.1
+  - 1.9.3
+
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rake test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dean Silfen
+
+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,52 @@
+# JAPI
+
+![build status](https://travis-ci.org/djds23/jApi.svg?branch=master)
+
+A simple ruby interface for the jservice.io API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'japi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install japi
+
+## Usage
+
+```ruby
+clue = JAPI::Trebek.random # ask trebek for a random question!
+puts clue.category.title # THE SOLAR SYSTEM
+puts clue.question # Only 1 of 9 planets not named for a Greek or Roman mythological figure
+
+answer = gets.chomp
+if answer == clue.answer
+  puts "The Earth! Correct!"
+  puts "Good answer! Thats worth #{clue.value} dollars!"
+else
+  puts "Too bad!"
+end
+```
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/djds23/japi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/console

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

data/bin/setup

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

data/japi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'japi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "japi"
+  spec.version       = JAPI::VERSION
+  spec.authors       = ["Dean Silfen"]
+  spec.email         = ["dean.silfen@gmail.com"]
+
+  spec.summary       = %q{A simple object wrapper for the jservice.io API.}
+  spec.description   = %q{A simple object wrapper for the jservice.io API.}
+  spec.homepage      = "http://btrebek.com/"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/japi.rb

@@ -0,0 +1,14 @@
+require "japi/version"
+require "japi/trebek"
+require "japi/category"
+require "japi/clue"
+
+
+module JAPI
+  require "open-uri"
+  require 'json'
+  require 'uri'
+
+  class InvalidParamError < StandardError; end
+end
+

data/lib/japi/category.rb

@@ -0,0 +1,29 @@
+module JAPI
+  class Category
+
+    def initialize(options = {})
+      @options = options
+      if @options["clues"]
+        @options["clues"] = @options["clues"].map { |clue| Clue.new(clue) }
+      end
+    end
+
+    def title
+      @options["title"]
+    end
+
+    def category_id
+      @options["id"]
+    end
+
+    def clues_count
+      @options["clues_count"]
+    end
+
+    def clues
+      return @options["clues"] unless @options["clues"].nil?
+      @options["clues"] = Trebek.category(10044).clues
+    end
+  end
+end
+

data/lib/japi/clue.rb

@@ -0,0 +1,33 @@
+module JAPI
+  class Clue
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def value
+      @options["value"]
+    end
+
+    def clue_id
+      @options["id"]
+    end
+
+    def category_id
+      @options["category_id"]
+    end
+
+    def game_id
+      @options["game_id"]
+    end
+
+    def question
+      @options["question"]
+    end
+
+    def answer
+      @options["answer"]
+    end
+  end
+end
+

data/lib/japi/trebek.rb

@@ -0,0 +1,86 @@
+module JAPI
+  class Trebek
+    class << self
+
+      # Get a random clue from the service
+      #
+      # @param count [Fixnum] amount of clues to return, limited to 100 at a time
+      #
+      # @return [Array<Clue>] A list of random clues
+      def random(count = 1)
+        url = base_url << "random/?" << URI.encode_www_form({count: count})
+        response = JSON.parse(open(url).read)
+
+        response.map do |clue|
+          Clue.new(clue)
+        end
+      end
+
+      # Get a list of clues from the service
+      #
+      # @param options [Hash{String, Symbol => Fixnum, DateTime}] hash of query params for clue endpoint
+      # @option options [Fixnum] :value the value of the clue in dollars
+      # @option options [Fixnum] :category the id of the category you want to return
+      # @option options [DateTime] :min_date earliest date to show, based on original air date
+      # @option options [DateTime] :max_date latest date to show, based on original air date
+      # @option options [Fixnum] :offset offsets the returned clues. Useful in pagination
+      #
+      # @return [Array<Clue>] A list of clues that fit the query params
+      def clues(options = {})
+        allowed_keys = ['value', 'category', 'max_date', 'min_date', 'offset']
+        options.keys.each do |key|
+          unless allowed_keys.include?(key.to_s)
+            message = "#{key} is not allowed, please only use the following options: #{allowed_keys.join(', ')}"
+            raise InvalidParamError.new(message)
+          end
+        end
+        query = URI.encode_www_form(options)
+        response = JSON.parse(open(base_url << 'clues/?' << query).read)
+
+        response.map do |clue|
+          Clue.new(clue)
+        end
+      end
+
+      # Get a list of categories from the service
+      #
+      # @param options [Hash{String, Symbol => Fixnum}] hash of query params for clue endpoint
+      # @option options [Fixnum] :count amount of categories to return, limited to 100 at a time
+      # @option options [Fixnum] :offset offsets the starting id of categories returned. Useful in pagination.
+      #
+      # @return [Array<Category>] A list of clues that fit the query params
+      def categories(options = {})
+        allowed_keys = ['count', 'offset']
+        options.keys.each do |key|
+          unless allowed_keys.include?(key.to_s)
+            message = "#{key} is not allowed, please only use the following options: #{allowed_keys.join(', ')}"
+            raise InvalidParamError.new(message)
+          end
+        end
+        query = URI.encode_www_form(options)
+        response = JSON.parse(open(base_url << 'categories/?' << query).read)
+
+        response.map do |category|
+          Category.new(category)
+        end
+      end
+
+      # Get clues of a single category from the service
+      #
+      # @param id [Fixnum] id of desired category
+      #
+      # @return [Category] A list of clues that fit the query params
+      def category(id)
+        query = URI.encode_www_form(id: id)
+        response = JSON.parse(open(base_url << 'category/?' << query).read)
+        Category.new(response)
+      end
+
+      private
+      def base_url
+        "http://jservice.io/api/"
+      end
+    end
+  end
+end
+

data/lib/japi/version.rb

@@ -0,0 +1,3 @@
+module JAPI
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: japi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dean Silfen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: A simple object wrapper for the jservice.io API.
+email:
+- dean.silfen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- japi.gemspec
+- lib/japi.rb
+- lib/japi/category.rb
+- lib/japi/clue.rb
+- lib/japi/trebek.rb
+- lib/japi/version.rb
+homepage: http://btrebek.com/
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple object wrapper for the jservice.io API.
+test_files: []
+has_rdoc: