chuck_norris 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1984303cbf408d25f4ae79ee0e38dccce15ac8f0
+  data.tar.gz: 418cc700cc8d5ba3ed82adbe1def42438902de3d
+SHA512:
+  metadata.gz: 594b690222b65c6f06f8b18a1a3b973c0a2a6310f8678e08a653090d743db477b1f74d426e11fa276192ae0326491248ff3bad11337d40303623ebffdda89344
+  data.tar.gz: 9809e491743bc49394f322cb71cea4733494cf0a027b4a11fb16e313f526b5e33c8a5c5a49f373b08666449c0f6584d7b19f7c680474e4d24e0e3347d15de530

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

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, 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chuck_norris.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Spencer Dixon
+
+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,90 @@
+# ChuckNorris
+
+ChuckNorris is a light weight Ruby wrapper around the Chuck Norris Joke API [found
+here](http://www.icndb.com/api/).  It contains a series of Chuck Norris jokes
+which can be customized with an individuals first and last name.
+
+## Usage
+
+#### Getting Random Joke
+Jokes have an id, joke, and categories you can query.
+```
+joke = ChuckNorris::JokeFinder.get_joke
+joke.id # => 497
+joke.joke # => "If Chuck Norris writes code with bugs, the bugs fix themselves." 
+joke.categories # => ["nerdy"]
+```
+
+You can customize the name of the person in the joke by passing in the
+`first_name` and `last_name` as options:
+
+```
+joke = ChuckNorris::JokeFinder.get_joke(first_name: 'Spencer', last_name: 'Dixon')
+joke.joke # => "Spencer Dixon doesn't read books. He stares them down until he gets the information he wants."
+```
+
+
+#### Getting Multiple Jokes
+You can get multiple jokes by passing the number you want as an argument to the
+`ChuckNorris.get_jokes` method. **NOTE** the `s` at the end.
+
+```
+jokes = ChuckNorris::JokeFinder.get_jokes(3)
+jokes[0].joke 
+# => "When Chuck Norris throws exceptions, it's across the room."
+
+jokes[1].joke 
+# => "The only sure things are Death and Taxes and when Chuck Norris goes to work for the IRS, they'll be the same thing." 
+
+jokes[2].joke 
+# => 
+```
+
+#### Finding Specific Joke
+You can fetch a specific joke by its `id`
+
+```
+bug_joke = ChuckNorris::JokeFinder.find_joke(497)
+bug_joke.joke # => "If Chuck Norris writes code with bugs, the bugs fix themselves." 
+```
+
+#### Fetching Joke Categories
+```
+categories = ChuckNorris::JokeFinder.joke_categories
+```
+
+#### Fetching Total Number Of Jokes
+```
+total = ChuckNorris::JokeFinder.joke_count
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chuck_norris'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chuck_norris
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chuck_norris/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :chuck_pry do
+  system 'rake build'
+  system 'rake install:local'
+  system 'pry -r chuck_norris'
+end

data/bin/console

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

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chuck_norris/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chuck_norris"
+  spec.version       = ChuckNorris::VERSION
+  spec.authors       = ["Spencer Dixon"]
+  spec.email         = ["spencercdixon@gmail.com"]
+
+  spec.summary       = %q{Light weight Chuck Norris API wrapper}
+  spec.description   = %q{API wrapper to get funny Chuck Norris jokes}
+  spec.homepage      = "https://github.com/spencercdixon/chuck_norris"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rest-client", '~> 0'
+  spec.add_development_dependency "json", '~> 0'
+  spec.add_development_dependency "pry", '~> 0'
+end

data/lib/chuck_norris.rb

@@ -0,0 +1,11 @@
+require "chuck_norris/version"
+require "chuck_norris/joke"
+require "chuck_norris/utility"
+require 'chuck_norris/joke_finder'
+require "rest-client"
+require "json"
+require 'pry'
+
+module ChuckNorris
+end
+

data/lib/chuck_norris/joke.rb

@@ -0,0 +1,10 @@
+module ChuckNorris
+  class Joke
+    attr_reader :id, :joke, :categories
+    def initialize(attrs)
+      @id = attrs["id"]
+      @joke = attrs["joke"]
+      @categories = attrs["categories"]
+    end
+  end
+end

data/lib/chuck_norris/joke_finder.rb

@@ -0,0 +1,32 @@
+require 'chuck_norris/utility'
+
+module ChuckNorris
+  class JokeFinder
+    extend Utility
+
+    def self.get_joke(options={})
+      response = execute(:get, '/jokes/random/', options)
+      Joke.new(response["value"])
+    end
+
+    def self.get_jokes(num, options={})
+      response = execute(:get, "/jokes/random/#{num}", options)
+      response["value"].map { |args| Joke.new(args) }
+    end
+
+    def self.joke_categories
+      response = execute(:get, "/categories")
+      response["value"]
+    end
+
+    def self.joke_count
+      response = execute(:get, "/jokes/count")
+      response["value"]
+    end
+
+    def self.find_joke(id)
+      response = execute(:get, "/jokes/#{id}")
+      Joke.new(response["value"])
+    end
+  end
+end

data/lib/chuck_norris/utility.rb

@@ -0,0 +1,26 @@
+module ChuckNorris
+  module Utility
+    API_URI = 'http://api.icndb.com'
+
+    def execute(method, path, options={})
+      options = sanitize_options(options)
+      url = API_URI + path + options
+      response = RestClient::Request.execute(method: method, url: url)
+      JSON.parse(response)
+    end
+
+    def sanitize_options(options)
+      return '' if options.empty?
+      final = {}
+      final[:firstName] = options.fetch(:first_name, 'Chuck')
+      final[:lastName] = options.fetch(:last_name, 'Norris')
+      to_query(final)
+    end
+
+    def to_query(hash)
+      query = '?'
+      hash.each {|k, v| query << "#{k}=#{v}&" }
+      query.chop
+    end
+  end
+end

data/lib/chuck_norris/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: chuck_norris
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Dixon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rest-client
+  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: json
+  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: pry
+  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: API wrapper to get funny Chuck Norris jokes
+email:
+- spencercdixon@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
+- chuck_norris.gemspec
+- lib/chuck_norris.rb
+- lib/chuck_norris/joke.rb
+- lib/chuck_norris/joke_finder.rb
+- lib/chuck_norris/utility.rb
+- lib/chuck_norris/version.rb
+homepage: https://github.com/spencercdixon/chuck_norris
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Light weight Chuck Norris API wrapper
+test_files: []