haar_joke 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 850926d8886841be7f7ba33a407fe7bca2caf014
+  data.tar.gz: f6cee45d0fdac24e6e1c43eccf6fb89b3d30ddca
+SHA512:
+  metadata.gz: f6677a849fdb20c4c4af699c83b2913168da9fa310d83a9655d24dfc455a26d0276c12a331c73e4710dba486a2365a5fb1fef58509801d275033d393cadc581d
+  data.tar.gz: b0ad431fcbdbb73cb37ad0c2b88dac4650c9fbeb4204f12b78c7e34a8499564fd9eb9ee06cb101d30c6722476c44016b14d73c9d2cd07bbcf00bedaa607ffcae

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haarjoke.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gemma Gotch
+
+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,77 @@
+# HaarJoke
+
+<img src="https://travis-ci.org/pveggie/haarjoke.svg?branch=master">
+
+HaarJoke can be used to create Chuck Norris type jokes featuring Haar.
+
+<img src="http://vignette2.wikia.nocookie.net/fireemblem/images/f/fb/Haar.jpg/revision/latest?cb=20090813131313">
+
+* Haar is a character from Fire Emblem: Path of Radiance and Fire Emblem:
+Radiant Dawn. He is know for being badass even while sleeping. Haar does not
+kill enemies; enemies kill themselves on Haar.
+
+<a href="http://www.gamefaqs.com/boards/932999-fire-emblem-radiant-dawn/41201620">http://www.gamefaqs.com/boards/932999-fire-emblem-radiant-dawn/41201620</a>
+
+Jokes are taken from The Internet Chuck Norris Database
+<a href="http://www.icndb.com/api/">(http://www.icndb.com/api/)</a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'haar_joke'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haar_joke
+
+## Usage
+
+You can generate a default Haar joke.
+
+```ruby
+HaarJoke.create_joke
+```
+
+You can also customise the joke to feature someone other than Haar,
+to substitute terms of your choice, and to filter out jokes based on terms.
+
+```ruby
+HaarJoke.create_custom_joke
+```
+
+This requires a YAML file listing filters and substituions at
+config/haar_joke.yml
+
+Example (No jokes about milk. Chuck Norris to be replaced by Brian):
+```yaml
+filters:
+  - milk
+substitutions:
+  chuck norrises: Brians
+  chuck norris': Brian's
+  chuck norris: Brian
+```
+
+
+## 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/pveggie/haarjoke.
+
+
+## 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,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 'haar_joke'
+
+# 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,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/haar_joke.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haar_joke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'haar_joke'
+  spec.version       = HaarJoke::VERSION
+  spec.authors       = ['Gemma Gotch']
+  spec.email         = ['pveggie@hotmail.com']
+
+  spec.summary       = 'Returns a joke based on a Chuck Norris joke but
+                          featuring Haar.'
+  spec.description   = 'Uses the Chuck Norris joke api and replaces Chuck
+                          Norris with the Fire Emblem character Haar.'
+  spec.homepage      = 'https://github.com/pveggie/haarjoke'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set
+  # the 'allowed_push_host' to allow pushing to a single host or delete
+  # this section to allow pushing 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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/lib/haar_joke/haar_joke.yml

@@ -0,0 +1,34 @@
+# jokes containing terms from the filters list will not be used
+filters:
+  # Add or remove filters as required.
+  - race
+  - woman
+  - women
+  - gay
+  - black
+  - natives
+  - porn
+  - handicap
+  - god
+  - bible
+  - staring
+  - rape
+  - condom
+
+# subsitutions is a list of terms that will be replaced with other terms
+substitutions:
+  # Add or remove subsitutions as required. Be careful about the order.
+  # e.g. substituting "america" first would change "american" to "daeinn"
+  chuck norrises: Haars
+  chuck norris': Haar's
+  chuck norris: Haar
+  penis: axe
+  dick: axe
+  american: Daein
+  america: Daein
+  beat: sleep
+  superman: Chuck Norris
+  beard: eyepatch
+  pick-up truck: wyvern
+  pick-up: wyvern
+  walk: fly

data/lib/haar_joke/joke.rb

@@ -0,0 +1,46 @@
+module HaarJoke
+  # This class can be used to create joke instances. The .text method
+  # returns the joke text.
+  class Joke
+    attr_reader :text
+
+    def text
+      @text = generate_joke
+    end
+
+    private
+
+    def generate_joke
+      joke = joke_from_api
+      !joke.nil? ? substitute_terms(joke) : 'Zzzzzzzzzzzzzzz. Haar is sleeping.'
+    end
+
+    def joke_from_api
+      api_url = 'http://api.icndb.com/jokes/random'
+      joke = ''
+
+      open(api_url) do |stream|
+        joke = JSON.parse(stream.read)
+      end
+
+      joke = joke['value']['joke']
+      accept_joke?(joke) ? joke : joke_from_api
+
+    rescue StandardError
+      nil
+    end
+
+    def accept_joke?(joke)
+      filters = HaarJoke.config['filters'].join('|')
+      joke.match(/#{filters}/i).nil?
+    end
+
+    def substitute_terms(joke)
+      substitutions = HaarJoke.config['substitutions']
+      substitutions.each do |key, value|
+        joke.gsub!(/#{key}/i, value)
+      end
+      joke
+    end
+  end
+end

data/lib/haar_joke/version.rb

@@ -0,0 +1,3 @@
+module HaarJoke
+  VERSION = '0.0.1'.freeze
+end

data/lib/haar_joke.rb

@@ -0,0 +1,40 @@
+require 'haar_joke/version'
+require 'haar_joke/joke'
+require 'json'
+require 'open-uri'
+require 'yaml'
+
+# This module contains a Joke class for creating jokes featuring the fire
+# Emblem Haar (using Chuck Norris jokes from http://api.icndb.com).
+# It also contains a method for creating a joke and getting returning the joke
+module HaarJoke
+  # load default filters and substitutions
+  file_path = File.join(File.dirname(__FILE__), 'haar_joke/haar_joke.yml')
+  @config = YAML.load_file(file_path)
+
+  # user can create joke with custom settings
+  def self.create_joke
+    joke = Joke.new
+    joke.text
+  end
+
+  # user can create joke with their own file
+  def self.create_custom_joke
+    @config = use_custom_file
+    create_joke
+  end
+
+  private
+
+  def self.use_custom_file
+    file_path = Rails.root.join('config/haar_joke.yml')
+    YAML.load_file(file_path)
+  rescue
+    raise 'YAML file missing. Custom method requires a config/haar_joke.yml
+    file. For non custom jokes, use HaarJoke.create_joke'
+  end
+
+  def self.config
+    @config
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: haar_joke
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gemma Gotch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: |-
+  Uses the Chuck Norris joke api and replaces Chuck
+                            Norris with the Fire Emblem character Haar.
+email:
+- pveggie@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- haar_joke.gemspec
+- lib/haar_joke.rb
+- lib/haar_joke/haar_joke.yml
+- lib/haar_joke/joke.rb
+- lib/haar_joke/version.rb
+homepage: https://github.com/pveggie/haarjoke
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Returns a joke based on a Chuck Norris joke but featuring Haar.
+test_files: []