japi 1.0.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 862c686aa9143561cfe97efd54771cc67591a523
-  data.tar.gz: 5f949b3b66cdd7d3fa99cb062945bc2f56b607f9
+  metadata.gz: bbe49a679d0618c5e14265c3a2a6359a7950df63
+  data.tar.gz: 96c5973c545bfa378203ca5d8184b9ed7989c79b
 SHA512:
-  metadata.gz: 9f06b7d239d71e19c23674550b50b36e86530a41f818c1587712d0c46cd7b661778521adc9f4b88143b4b6e6802d624762baf52c1a52c86956365f7a164932fc
-  data.tar.gz: 65b646623b4a25ac98fa3318de6d3f30864d2fd383644af839f009e49315783d2d051911b41b99daa8501ff2c8b5d6b541733b3eecc8713c4c0f74c4222cea45
+  metadata.gz: 010d4fb6603bfd2fe31157615457e0be63f545427ec65f72e515a3b180486fd8b5e188b63fcbfa0aa484636fb8a289477fdb7cd4779f0acb4c61b2c79dd693ed
+  data.tar.gz: 43511e4f1e3c0ce7a694d9cab5fef84bbc73017c2d5a53c2deaf693964cef60ead46e549a7a10567da0ee1408e9ee3a713628536ffb3530a643cdeea639b8be3

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.3.0
+  - 2.2.3
   - 2.2.1
   - 2.1.1
   - 1.9.3

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-clue = JAPI::Trebek.random # ask trebek for a random question!
+clue = JAPI::Trebek.random.first # 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
 
@@ -35,6 +35,19 @@ else
   puts "Too bad!"
 end
 ```
+
+You can host your own jservice.io, and configure the gem to use arbitrary endpoints.
+
+### Example Configuration
+
+```ruby
+require 'japi'
+
+JAPI.configuration do |config|
+ config.jservice_url = "http://my-selfhosted-jservice.com"
+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.

data/japi.gemspec

@@ -4,20 +4,23 @@ $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.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.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://jeopardean.com"
+  spec.license               = "MIT"
+  spec.required_ruby_version = '>= 1.9.3'
 
-  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.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_runtime_dependency 'configurations', '~> 2.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/japi.rb

@@ -1,14 +1,26 @@
-require "japi/version"
-require "japi/trebek"
-require "japi/category"
-require "japi/clue"
-
+require 'japi/version'
+require 'japi/trebek'
+require 'japi/category'
+require 'japi/clue'
 
+# namespace for JAPI, holds Clue, Category, Trebek, etc...
+#
+# @author Dean Silfen
 module JAPI
-  require "open-uri"
+  require 'configurations'
+  require 'open-uri'
   require 'json'
   require 'uri'
 
+  # Exception for attempting to pass illegal params to the API
+  #
+  # @author Dean Silfen
   class InvalidParamError < StandardError; end
+
+  include Configurations
+  configurable String, :jservice_url
+  configuration_defaults do |config|
+    config.jservice_url = "http://jservice.io/api/"
+  end
 end
 

data/lib/japi/category.rb

@@ -1,6 +1,13 @@
 module JAPI
-  class Category
-
+  # Category object with associated clues and a title.
+  #
+  # @author Dean Silfen
+    class Category
+    # @param options [Hash{String, Symbol => Fixnum, String}]
+    # @option options [Fixnum] :clues_count amount of clues associated with this category
+    # @option options [Fixnum] :id category id
+    # @option options [Array<Hash>] :clues hashes for constructing clues. see {Clue}
+    # @option options [String] :title the name of the category
     def initialize(options = {})
       @options = options
       if @options["clues"]
@@ -8,18 +15,22 @@ module JAPI
       end
     end
 
+    # @return [String] title of the category
     def title
       @options["title"]
     end
 
+    # @return [Fixnum] id of the category
     def category_id
       @options["id"]
     end
 
+    # @return [Fixnum] amount of clues associated with this category
     def clues_count
       @options["clues_count"]
     end
 
+    # @return [Array<Clue>] array of clues associated with a Category
     def clues
       return @options["clues"] unless @options["clues"].nil?
       @options["clues"] = Trebek.category(category_id).clues
@@ -27,3 +38,4 @@ module JAPI
   end
 end
 
+

data/lib/japi/clue.rb

@@ -1,34 +1,53 @@
 module JAPI
-  class Clue
 
+  # Clue object with a question, answer and other details.
+  #
+  # @author Dean Silfen
+    class Clue
+
+    # @param options [Hash{String, Symbol => Fixnum, String, DateTime, Hash}]
+    # @option options [Fixnum] :value amount in dollars of question
+    # @option options [Fixnum] :id clue id
+    # @option options [Fixnum] :category_id id of the clue's category
+    # @option options [Fixnum] :game_id id of the game where the clue appeared
+    # @option options [Hash] :category Hash containing Category info. see {JAPI::Category}
+    # @option options [String] :question the question text
+    # @option options [String] :answer the answer text
     def initialize(options = {})
       @options = options
     end
 
+    # @return [Fixnum] amount in dollars of question
     def value
       @options["value"]
     end
 
+    # @return [Fixnum] clue id
     def clue_id
       @options["id"]
     end
 
+    # @return [Fixnum] category id
     def category_id
       @options["category_id"]
     end
 
+    # @return [Category] category associated with this Clue
     def category
       Category.new(@options["category"])
     end
 
+    # @return [Fixnum] id of the game this clue initially aired on
     def game_id
       @options["game_id"]
     end
 
+    # @return [String] question text for this clue
     def question
       @options["question"]
     end
 
+    # @return [String] answer text for this clue
     def answer
       @options["answer"]
     end

data/lib/japi/trebek.rb

@@ -1,5 +1,8 @@
 module JAPI
-  class Trebek
+  # Interface for creating and requesting Clues & Categories
+  #
+  # @author Dean Silfen
+    class Trebek
     class << self
 
       # Get a random clue from the service
@@ -8,7 +11,7 @@ module JAPI
       #
       # @return [Array<Clue>] A list of random clues
       def random(count = 1)
-        url = base_url << "random/?" << URI.encode_www_form({count: count})
+        url = base_url + "random/?" + URI.encode_www_form({count: count})
         response = JSON.parse(open(url).read)
 
         response.map do |clue|
@@ -26,6 +29,7 @@ module JAPI
       # @option options [Fixnum] :offset offsets the returned clues. Useful in pagination
       #
       # @return [Array<Clue>] A list of clues that fit the query params
+      # @raise [InvalidParamError] if param not accepted by API is passed
       def clues(options = {})
         allowed_keys = ['value', 'category', 'max_date', 'min_date', 'offset']
         options.keys.each do |key|
@@ -35,7 +39,7 @@ module JAPI
           end
         end
         query = URI.encode_www_form(options)
-        response = JSON.parse(open(base_url << 'clues/?' << query).read)
+        response = JSON.parse(open(base_url + 'clues/?' + query).read)
 
         response.map do |clue|
           Clue.new(clue)
@@ -49,6 +53,7 @@ module JAPI
       # @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
+      # @raise [InvalidParamError] if param not accepted by API is passed
       def categories(options = {})
         allowed_keys = ['count', 'offset']
         options.keys.each do |key|
@@ -58,7 +63,7 @@ module JAPI
           end
         end
         query = URI.encode_www_form(options)
-        response = JSON.parse(open(base_url << 'categories/?' << query).read)
+        response = JSON.parse(open(base_url + 'categories/?' + query).read)
 
         response.map do |category|
           Category.new(category)
@@ -72,13 +77,17 @@ module JAPI
       # @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)
+        response = JSON.parse(open(base_url + 'category/?' + query).read)
         Category.new(response)
       end
 
       private
+
+      # @private
+      # @return [String] base url for jservice.io endpoint, configurable with
+      #   JAPI.configuration block method.
       def base_url
-        "http://jservice.io/api/"
+        JAPI.configuration.jservice_url
       end
     end
   end

data/lib/japi/version.rb

@@ -1,3 +1,4 @@
 module JAPI
-  VERSION = "1.0.2"
+  # @private
+  VERSION = "1.1.2"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: japi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.2
 platform: ruby
 authors:
 - Dean Silfen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: configurations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +103,7 @@ files:
 - lib/japi/clue.rb
 - lib/japi/trebek.rb
 - lib/japi/version.rb
-homepage: http://btrebek.com/
+homepage: http://jeopardean.com
 licenses:
 - MIT
 metadata: {}
@@ -101,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -109,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple object wrapper for the jservice.io API.