bomberman 1.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+*.sublime-*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@narya-client --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LupineDev
+
+MIT License
+
+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,114 @@
+# Bomberman
+
+This is a ruby client gem for the Bomberman HTTP API. It has been built
+and tested against Ruby 1.9.3.
+
+[Bomberman](http://addons.heroku.com/bomberman): shelter from profanity bombing, is an [add-on](http://addons.heroku.com) for Heroku
+applications. If you would like to be part of the alpha or early beta
+testing process please email <bomberman-support@ikayzo.com>.
+
+For detailed instructions on installing the addon to your Heroku
+application please see our [add-on documentation page](http://bomberman.ikayzo.com/)
+
+## Using with Rails 3.x
+
+We developed a ruby client gem for making requests to the
+Bomberman API.
+
+Ruby on Rails applications will need to add the following entry into their `Gemfile` specifying the Bomberman client library.
+
+```ruby
+gem 'bomberman'
+```
+
+Update application dependencies with bundler.
+
+```term
+$ bundle install
+```
+
+Now create an initializer file `config/initializers/bomberman.rb` with
+your `BOMBERMAN_API_KEY`
+
+```ruby
+Bomberman.configure do |config|
+  config.api_key = ENV['BOMBERMAN_API_KEY']
+end
+```
+From here you can call the Bomberman::Profanity functionality within
+your application.
+
+### Checking if Text Contains Profanity
+
+To check if a piece of text or *corpus* contains profanity use the
+`.profane?(corpus)` method.  This will return a boolean value as the
+result
+
+```ruby
+non_profane_text = "The quick brown fox jumped over the lazy dog."
+Bomberman::Profanity.profane?(non_profane_text)
+  #=> false
+profane_text = "The quick brown fox jumped over the F-BOMBing lazy dog."
+Bomberman::Profanity.profane?(profane_text)
+  #=> true
+```
+    
+### Censoring Profane Words & Phrases
+
+If you would like to save or display text where the profane words (if
+any) are obfuscated the `.censor(corpus, replacement_text)` method is
+what you are looking for.
+
+```ruby
+non_profane_text = "The quick brown fox jumped over the lazy dog."
+Bomberman::Profanity.censor(non_profane_text, "####")
+  #=> "The quick brown fox jumped over the lazy dog."
+profane_text = "The quick brown fox jumped over the F-BOMBing lazy dog."
+Bomberman::Profanity.censor(profane_text, "####")
+  #=> "The quick brown fox jumped over the ### lazy dog."
+```
+
+The `replacement_text` parameter is a string and optional. `"***"` is
+suppled by default.
+
+### Highlighting Profane Words & Phrases
+
+Sometimes it is useful to leave the original profane word/phrase intact
+but wrap it in some sort of tag to make it stand out. This can be
+accomplished with the `.highlight(corpus, start_tag, end_tag)` method.
+
+```ruby
+non_profane_text = "The quick brown fox jumped over the lazy dog."
+BomberMan::Profanity.highlight(non_profane_text, "<blink>", "</blink>")
+  #=> "The quick brown fox jumped over the lazy dog."
+profane_text = "The quick brown fox jumped over the F-BOMBing lazy dog."
+BomberMan::Profanity.highlight(profane_text, "<blink>", "</blink>")
+  #=> "The quick brown fox jumped over the <blink>F-BOMBing</blink> lazy dog."
+```
+
+The `start_tag` & `end_tag` parameters are strings and optional. A pair
+of opening and closing `<span>` tags are used if none are provided.
+
+
+### Checking Japanese Text for Profanity.
+
+Bomberman supports for checking Japanese text for profanity.
+To do this pass an optional language argument with the value `:ja` as the
+last parameter to any of the `Bomberman::Profanity` methods
+
+```ruby
+non_profane_text = "聖パトリックの日"
+Bomberman::Profanity.profane?(non_profane_text, :ja)
+  #=> false
+```
+
+For more info on customizing Bomberman please refer to the [add-on documentation](http://bomberman.ikayzo.com/).
+## Troubleshooting
+
+We are just starting out.  If you experience trouble please contact us
+at <bomberman-support@ikayzo.com>.
+
+## Contributing
+
+Given the early stage of this project we are open to comments &
+suggestions for this library please send them to <bomberman-support@ikayzo.com>.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bomberman.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bomberman/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bomberman"
+  gem.version       = Bomberman::VERSION
+  gem.authors       = ["Ikayzo"]
+  gem.email         = ["chris@ikayzo.com"]
+  gem.summary       = %q{Shelter from profanity bombing}
+  gem.description   = %q{Client for interacting with Bomberman HTTP API. For more information visit http://bomberman.ikayzo.com/}
+  gem.homepage      = "https://github.com/ikayzo/bomberman-ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "faraday", ["~>0.8.5"]
+  gem.add_runtime_dependency "json", [">=1.7.7"]
+  gem.add_development_dependency "rspec", ["~>2.12.0"]
+end

data/lib/bomberman.rb

@@ -0,0 +1,18 @@
+require 'bomberman/configuration'
+require 'bomberman/connection'
+require 'bomberman/error'
+require 'bomberman/profanity'
+require 'bomberman/string_utils'
+require 'bomberman/version'
+
+module Bomberman
+  class << self
+    include Bomberman::Configuration
+    #include Bomberman::Connection
+    attr_reader :connection
+
+    def connection
+      @connection ||= Connection.new
+    end
+  end
+end

data/lib/bomberman/configuration.rb

@@ -0,0 +1,30 @@
+module Bomberman
+  module Configuration
+    VALID_OPTIONS = [:api_key, :api_version, :include_string_utils, :url].freeze
+    DEFAULT_VALUES = {
+        api_key: 'change me',
+        api_version: 1,
+        use_https: true,
+        include_string_utils: false,
+        url: 'bomberman-prod.herokuapp.com'
+    }.freeze
+    attr_accessor(*VALID_OPTIONS)
+    class << self
+
+    end
+
+    def configure
+      reset
+      yield self
+      self
+    end
+
+    def reset
+      VALID_OPTIONS.each do |key|
+        instance_variable_set(:"@#{key}", DEFAULT_VALUES[key])
+      end
+      self
+    end
+    alias setup reset
+  end
+end

data/lib/bomberman/connection.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+
+module Bomberman
+  class Connection < Faraday::Connection
+    def initialize
+      super('https://' + Bomberman.url)
+      self.headers['Content-Type'] = 'application/json; charset=utf-8'
+      self.headers['Authorization'] = "Token token=#{Bomberman.api_key}"
+      self
+    end
+  end
+end

data/lib/bomberman/error.rb

@@ -0,0 +1,25 @@
+module Bomberman
+  class Error < StandardError; end
+
+  class BadRequest < Error; end
+
+  class Unauthorized < Error; end
+
+  class Forbidden < Error; end
+
+  class NotFound < Error; end
+
+  class NotAcceptable < Error; end
+
+  class UnprocessableEntity < Error; end
+
+  class InternalServerError < Error; end
+
+  class NotImplemented < Error; end
+
+  class BadGateway < Error; end
+
+  class ServiceUnavailable < Error; end
+
+  class LanguageNotSupported < Error; end
+end

data/lib/bomberman/profanity.rb

@@ -0,0 +1,62 @@
+require 'json'
+module Bomberman
+  module Profanity
+    def self.profane?(corpus=nil, language=:en)
+      request = Bomberman.connection.get do |req|
+        req.url "#{lang_api_version(language)}/profanity/check", corpus: corpus
+      end
+
+      validate_status(request)
+
+      if request.status == 200
+        request.body.eql?("1") ? true : false
+      end
+    end
+
+    def self.censor(corpus=nil, replacement_text=nil, language=:en)
+      request = Bomberman.connection.get do |req|
+        req.url "#{lang_api_version(language)}/profanity/censor", corpus: corpus, replacement_text: replacement_text
+      end
+
+      validate_status(request)
+
+      if request.status == 200
+        JSON.parse(request.body)['censored_text']
+      end
+    end
+
+    def self.highlight(corpus=nil, start_tag=nil, end_tag=nil, language=:en)
+      request = Bomberman.connection.get do |req|
+        req.url "#{lang_api_version(language)}/profanity/highlight", corpus: corpus, start_tag: start_tag, end_tag: end_tag
+      end
+
+      validate_status(request)
+
+      if request.status == 200
+        JSON.parse(request.body)['highlighted_text']
+      end
+    end
+
+    private
+
+    def self.lang_api_version(language=:en)
+      if language == :en
+       "v#{Bomberman.api_version}"
+      elsif language == :ja
+       "#{language}/v#{Bomberman.api_version}"
+      else
+        raise Bomberman::LanguageNotSupported
+      end
+    end
+
+    def self.validate_status(request)
+      if request.status == 400
+        raise Bomberman::BadRequest
+      elsif request.status == 401
+        raise Bomberman::Unauthorized
+      elsif request.status == 500
+        raise Bomberman::InternalServerError
+      end
+    end
+  end
+end

data/lib/bomberman/string_utils.rb

@@ -0,0 +1,9 @@
+module Bomberman
+  module StringUtils
+    String.class_eval do
+      def profane?
+        Bomberman::Profanity.profane?(self) if Bomberman.include_string_utils
+      end
+    end
+  end
+end

data/lib/bomberman/version.rb

@@ -0,0 +1,3 @@
+module Bomberman
+  VERSION = "1.0.1"
+end

data/spec/lib/bomberman/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Bomberman::Configuration do
+  it 'should have default values' do
+    config = Bomberman.configure {}
+    config.api_key.should eq('change me')
+    config.api_version.should eq(1)
+    config.include_string_utils.should eq(false)
+    config.url.should eq('bomberman-prod.herokuapp.com')
+  end
+end

data/spec/lib/bomberman/connection_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+
+describe Bomberman::Connection do
+  before :all do
+    Bomberman.configure {}
+  end
+
+  it 'should inherit from Faraday::Connection' do
+    Bomberman::Connection.new.should be_a(Faraday::Connection)
+  end
+
+  describe "constructor" do
+    before :all do
+      @connection = Bomberman::Connection.new
+    end
+
+    it "should initialize with url based on config values" do
+      @connection.host.should eq(Bomberman.url)
+    end
+
+    it "should set the headers with application/json content type" do
+      @connection.headers['Content-Type'].should eq('application/json; charset=utf-8')
+    end
+
+    it "should set the headers correct api authorization params" do
+      auth_headers = "Token token=#{Bomberman.api_key}"
+      @connection.headers['Authorization'].should eq(auth_headers)
+    end
+  end
+end

data/spec/lib/bomberman/profanity_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+
+describe Bomberman::Profanity do
+  before :all do
+    Bomberman.configure {}
+  end
+
+  it 'should do a get request' do
+    pending "need webmock tests"
+    Bomberman.connection.should_receive(:get)
+    Bomberman::Profanity.profane?("alkjsdf")
+  end
+end

data/spec/lib/bomberman/string_utils_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Bomberman::StringUtils do
+  describe "String extension" do
+      it "should give strings the #profane? method" do
+        "str".public_methods.should include(:profane?)
+      end
+    context "When include_string_utils is set to true" do
+      before :all do
+        Bomberman.configure do |config|
+          config.include_string_utils = true
+        end
+      end
+
+      it "should check the string to see if it's profane" do
+        string = "my str"
+        Bomberman::Profanity.should_receive(:profane?).with(string)
+        string.profane?
+      end
+
+    end
+
+    context "When include_string_utils is set to false" do
+      before :all do
+        Bomberman.configure {}
+      end
+
+      it "should NOT check the string to see if it's profane" do
+        string = "my str"
+        Bomberman::Profanity.should_not_receive(:profane?).with(string)
+        string.profane?
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bomberman'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: bomberman
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ikayzo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Client for interacting with Bomberman HTTP API. For more information
+  visit http://bomberman.ikayzo.com/
+email:
+- chris@ikayzo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bomberman.gemspec
+- lib/bomberman.rb
+- lib/bomberman/configuration.rb
+- lib/bomberman/connection.rb
+- lib/bomberman/error.rb
+- lib/bomberman/profanity.rb
+- lib/bomberman/string_utils.rb
+- lib/bomberman/version.rb
+- spec/lib/bomberman/configuration_spec.rb
+- spec/lib/bomberman/connection_spec.rb
+- spec/lib/bomberman/profanity_spec.rb
+- spec/lib/bomberman/string_utils_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ikayzo/bomberman-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Shelter from profanity bombing
+test_files:
+- spec/lib/bomberman/configuration_spec.rb
+- spec/lib/bomberman/connection_spec.rb
+- spec/lib/bomberman/profanity_spec.rb
+- spec/lib/bomberman/string_utils_spec.rb
+- spec/spec_helper.rb