whatimean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deec3dc2c866e548b09ae1b2ef7cc94fe2016052
+  data.tar.gz: 178da8c3f4d4bca07e18a2227876e78bf198eba2
+SHA512:
+  metadata.gz: d34f6578a9cd9d0a199433442cc458fccb98a419ff599b888b0e99736c9b3239ae5c146e8140282e5a7bc29820f49af2e0ece312b25fab42c161f3bcc0388d77
+  data.tar.gz: af9c6eb55fb00fe10d5748055cc887332f41574b1855596c420fb58eb8a1378ac50e1f11c0a550c2bbef6dbbca27e2298db47e2a6a2c0dfa0cfc6cd1dd13c804

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

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 Joao Fraga
+
+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,73 @@
+# Whatimean
+
+[![Code Climate](https://codeclimate.com/github/joaofraga/whatimean/badges/gpa.svg)](https://codeclimate.com/github/joaofraga/whatimean) [![Test Coverage](https://codeclimate.com/github/joaofraga/whatimean/badges/coverage.svg)](https://codeclimate.com/github/joaofraga/whatimean/coverage) [![Build Status](https://travis-ci.org/joaofraga/whatimean.svg)](https://travis-ci.org/joaofraga/whatimean)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/whatimean`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whatimean'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whatimean
+
+## Usage
+
+First add your Google Console API Key:
+
+``` ruby
+WhatIMean.configure do |config|
+  config.api_key = "MY_API"
+end
+```
+
+You can now discover which word is the correct using:
+
+``` ruby
+WhatIMean.is? 'word1', 'word2'
+```
+
+To discover the winner, just:
+
+``` ruby
+word_fight = WhatIMean.is? 'google', 'altavista'
+word_fight.winner
+
+#=> #<WhatIMean::Word:0x007ffcba4960d8 @name="google", @hits=824000000, @rate=0.9987031403396075>
+```
+
+To list the searched words:
+
+``` ruby
+word_fight = WhatIMean.is? 'google', 'altavista'
+word_fight.words
+
+#=> [#<WhatIMean::Word:0x007ffcba4960d8 @name="google", @hits=824000000, @rate=0.9987031403396075>, #<WhatIMean::Word:0x007ffcba4ae750 @name="altavista", @hits=1070000, @rate=0.0012968596603924515>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/joaofraga/whatimean. 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,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 "whatimean"
+
+# 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/lib/whatimean.rb

@@ -0,0 +1,47 @@
+require 'whatimean/find'
+require 'whatimean/google'
+require 'whatimean/word'
+require 'whatimean/version'
+
+module WhatIMean
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Call this method to modify defaults in your initializers.
+  #
+  # @example
+  #   WhatIMean.configure do |config|
+  #     config.api_key = 'MY_API_KEY'
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # = Configuration
+  #
+  # Where you configure WhatIMean.
+  class Configuration
+    # The Google Console API key for your project.
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = 'MY_API_KEY'
+    end
+  end
+
+  # Compare strings and return a list ordered by occurence
+  # @param [Array<String>] words The words to be compared
+  # @return [Array<Word>] the words with hits counter and comparison rates
+  def self.is(*words)
+    Find.new(client, *words)
+  end
+
+  private
+
+  # The WhatIMean::Google client
+  def self.client
+    @client ||= Google.new(WhatIMean.configuration.api_key)
+  end
+end

data/lib/whatimean/find.rb

@@ -0,0 +1,38 @@
+module WhatIMean
+  # = Find
+  # The Core of WhatIMean, this class interacts with Google and Word and
+  # fetch the search returning each word with hits, name and rate comparison
+  class Find
+    attr_reader :words
+
+    # Compare strings and return a list ordered by occurence
+    # @param [Google] client The WhatIMean::Google client
+    # @param [Array<String>] words The words to be compared
+    # @return [Find] the words with hits counter and comparison rates
+    def initialize(client, *words)
+      @client = client
+      @words = fetch_words(words).sort { |x,y| y.hits <=> x.hits }
+    end
+
+    # Returns the word in comparison with most results
+    # @return [Word] The winner with most occurences
+    def winner
+      @words.first
+    end
+
+    private
+
+    def fetch_words(words)
+      words = words.map do |word|
+        @client.search(word)
+      end
+
+      calculate_rate(words)
+    end
+
+    def calculate_rate(words)
+      total = words.map(&:hits).inject(&:+).to_f
+      words.map { |word| word.calculate_rate(total) }
+    end
+  end
+end

data/lib/whatimean/google.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'open-uri'
+require 'cgi'
+
+module WhatIMean
+  class Google
+    # Url to Google Custom Search API
+    BASE_URL = 'https://www.googleapis.com/customsearch/v1?cref&key={key}&q={word}'
+
+    # Instantiate a new Google client object
+    # @param [String] key Google Console Custom Search API KEY
+    # @return [Google]
+    def initialize(key)
+      @key = key
+    end
+
+    # Searchs a string with Google Custom Search
+    # @param [String] word
+    # @return [Word]
+    def search(word)
+      WhatIMean::Word.new(name: word, hits: fetch_word(word))
+    end
+
+    private
+
+    def url_to(word)
+      BASE_URL.gsub(/{key}/, @key).gsub(/{word}/, CGI.escape(word))
+    end
+
+    def fetch_word(word)
+      open(url_to(word), "Referer" => "http://whatimean.com", "User-Agent" => "WhatIMean::Robot", ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |f|
+        JSON.parse(f.read)['searchInformation']['totalResults'].to_i
+      end
+    end
+  end
+end

data/lib/whatimean/version.rb

@@ -0,0 +1,4 @@
+module WhatIMean
+  # WhatIMean Version bumper
+  VERSION = "0.1.0"
+end

data/lib/whatimean/word.rb

@@ -0,0 +1,28 @@
+module WhatIMean
+
+  class Word
+    attr_accessor :name, :hits, :rate
+
+    # Instatiate a new Word with following attributes:
+    # @param [Hash] attributes Data that will be set in Word.
+    #
+    # @option attributes [String] :name Word name
+    # @option attributes [Fixnum] :hits Estimated hit count (occurrences)
+    # @option attributes [Float] :rate Rate comparison based on total value
+    def initialize(attributes)
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+
+      self
+    end
+
+    # Calculate
+    # @param [Float] total The total ammount to be compared
+    # @return [Word] self object
+    def calculate_rate(total)
+      self.rate = hits / total.to_f
+      self
+    end
+  end
+end

data/whatimean.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whatimean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whatimean"
+  spec.version       = WhatIMean::VERSION
+  spec.authors       = ["Joao Fraga"]
+  spec.email         = ["jgfraga@gmail.com"]
+
+  spec.summary       = %q{Discover the correct typo of a word using Google search.}
+  spec.description   = %q{Discover the correct typo of a word using Google search.}
+  spec.homepage      = "https://github.com/joaofraga/whatimean"
+  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 "vcr"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: whatimean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joao Fraga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-28 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: vcr
+  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: codeclimate-test-reporter
+  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: Discover the correct typo of a word using Google search.
+email:
+- jgfraga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/whatimean.rb
+- lib/whatimean/find.rb
+- lib/whatimean/google.rb
+- lib/whatimean/version.rb
+- lib/whatimean/word.rb
+- whatimean.gemspec
+homepage: https://github.com/joaofraga/whatimean
+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: Discover the correct typo of a word using Google search.
+test_files: []