nebrija 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b05db641a064b02de12be55a7213ebd7a8c33032
-  data.tar.gz: bd51dda0fee5787e964959ae8fc5b43204553407
+  metadata.gz: b95042bf3ffa9ca78eab2ce3260555933c485ae1
+  data.tar.gz: 4134ce0676ac430ea22bb6566d0f1c7a2abbac13
 SHA512:
-  metadata.gz: d0ecbd51c7867bec5cdd08e8af68db16a63b8c2c41c63d1cfd2cf91d37db38883208aea672e59833179e04dbbb312add2606e41320f1eb8a6e0af95ad0327c9c
-  data.tar.gz: 126b5dd142c1958043178b7d1c8b68010f67c6b56a6e183cd16e541946f3cc614119fc525836065a766580dae4f820b9e95646959c5add7d0af355f5197421a0
+  metadata.gz: 475ea89fd7ed720b6d106b66b9e6fd1a7ed1ddcec94336cf932879147a897b3669f06f81cea4eece68cc7b011aaff706b63416410f680493f94ed4b799621a8c
+  data.tar.gz: 2f5a5cfd780e960189aa6a588def16cda593490990ef4e4bbd3e41e1cbdd7204d4d56eb8e084f612900867b349edbbd88ebffd8cfbdc90b983a8cc10ee625029

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Style/FrozenStringLiteralComment:
+  Enabled: False
 Metrics/LineLength:
   Max: 85
 Metrics/MethodLength:

data/.travis.yml

@@ -1,6 +1,7 @@
-sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.3.1
-cache: bundler
-
+install: bundle install
+script: script/cibuild
+sudo: false

data/README.md

@@ -1,51 +1,63 @@
-Nebrija: A rae parser
-=====================
+## Nebrija: A rae parser
 
 [![Build Status](https://travis-ci.org/javierhonduco/nebrija.svg?branch=master)](https://travis-ci.org/javierhonduco/nebrija)
 [![Code Climate](https://img.shields.io/codeclimate/github/javierhonduco/nebrija.svg)](https://codeclimate.com/github/javierhonduco/nebrija)
 
 
-Install
--------
-
+### Installing
 ```bash
 $ gem install nebrija
 ```
 
-API
----
+### Usage
 ```ruby
 require 'nebrija'
-res = Rae.new.search('word/id')
+res = Rae.search('word/id') # e.g. Rae.search('amigo')
+
 puts res # prints the results
 ```
 
-`HTTPRae` returns a hash where the key `status` can be `error`|`success`.
+`Rae#search` returns a hash where the key `status` can be [`error`|`success`].
 
-If the request is succesful, the key `type` indicates whether the result type is a single word or multiple  with `single`|`multiple`.
+If the request is successful, the key `type` indicates whether the result type is a single word or multiple  with [`single`|`multiple`].
 
-The response data can be found in the `response` key which holds an array.
+The response data can be found in the `response` key which holds a hash with all the information.
 
-The response data is formatted as shown in the [nebrija/cli](https://github.com/javierhonduco/nebrija/blob/master/lib/nebrija/cli.rb) file:
+An example on how to iterate over the info can be seen in the [CLI code](https://github.com/javierhonduco/nebrija/blob/master/lib/nebrija/cli.rb) file:
 
-CLI searching
----------
+### CLI
 ```bash
 $ nebrija <word>
 ```
 
-Maybe you are lazy and want to add an alias to `rae` or `es` like I do :)
+If you feel it is too cumbersome to type, you can add an alias :)
 
-Friend projects/ project using this gem
----------------------------------------
+### Projects using this gem
 * [Rae downloader](https://github.com/raul/rae-downloader) by [@raul](https://github.com/raul)
 * [Dulcinea: a nebrija frontend](https://github.com/javierhonduco/dulcinea)
 
-TODO
-----
-* Improve the API.
-* Update clients to use new API.
-* Fix multiple responses.
-* Better doc.
-* Mockless testing.
+### Contributing
+Feel free to submit any issue or PR 😃.
+
+In order to test your changes:
+```bash
+# you can run the tests
+$ bundle exec rake [test]
+# run the CLI
+$ bundle exec nebrija word-to-be-searched
+# run the "debug" CLI, which pretty prints the resulting hash
+$ bundle exec bin/debug word-to-be-searched
+```
+
+Additionally, you can get some debug traces in stderr via the `NEBRIJA_DEBUG` environment variable.
+
+When set, it will output the requested word, the generated URL, and the HTTP status code that it got from the server.
+If you wish to see the returned body's output as well, you can set it to `2`.
+
+The tests are [mocked](https://en.wikipedia.org/wiki/Mock_object) so we run our tests using some already downloaded answers from rae.es. However, in some cases, one would like to bypass the mocks and use the real webpages instead. You can achieve that by setting the `NO_MOCK` env var when running your tests.
+
+It was added as part as the continuous integrations testing with Travis. They introduced an amazing feature, 💛💚💙💖[scheduled builds](https://blog.travis-ci.com/2016-12-06-the-crons-are-here). Given that rae.es changes the way its [auth method](https://github.com/javierhonduco/nebrija/blob/086f1cc0341cad538b9c72406fe76bbb6d5d4394/lib/nebrija/rae.rb#L38-L49) works from time to time, the tests without being mocked are run in a daily basis so we know if something is broken.
+### TODO
 * Make the parser more readable.
+* Improve the API.
+* Think on multiple responses and how to address them.

data/bin/debug

@@ -4,4 +4,4 @@ require 'json'
 require 'pp'
 require 'nebrija'
 
-pp Rae.new.search(ARGV.first)
+pp Rae.search(ARGV.first)

data/lib/nebrija/rae.rb

@@ -8,40 +8,57 @@ class Rae
   OPEN_TIMEOUT  = 2
   READ_TIMEOUT  = 3
 
+  def self.search(word)
+    new.search word
+  end
+
+  # old method, mantained for compatibility
   def search(word)
     Parser.new(query(word)).parse
   end
 
-  private
-
   def query(word)
     uri = URI.parse "#{SEARCH_URL}?w=#{CGI.escape(word)}".encode('iso-8859-1')
 
+    request = Net::HTTP::Post.new(uri)
+    request['User-Agent'] = USER_AGENT
+    request.form_data = form_data
+
     Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
       http.open_timeout = OPEN_TIMEOUT
       http.read_timeout = READ_TIMEOUT
 
-      request = Net::HTTP::Post.new(uri)
-      request['User-Agent'] = USER_AGENT
-      request.form_data = form_data
-
       response = http.request request
+      debug(word, uri, response.code, response.body) if ENV['NEBRIJA_DEBUG']
 
       response.body
     end
   end
 
-  private
   def form_data
     {
-      'TS017111a7_id' => '3',
-      'TS017111a7_cr' => '1895c885a17201dca76eb401d01fd59f:jlmn:U9YRi5sw:1485055093',
-      'TS017111a7_76' => '0',
-      'TS017111a7_86' => '0',
-      'TS017111a7_md' => '1',
-      'TS017111a7_rf' => '0',
-      'TS017111a7_ct' => '0',
-      'TS017111a7_pd' => '0',
+      'TS017111a7_id': '3',
+      'TS017111a7_cr': '1895c885a17201dca76eb401d01fd59f:jlmn:U9YRi5sw:1485055093',
+      'TS017111a7_76': '0',
+      'TS017111a7_86': '0',
+      'TS017111a7_md': '1',
+      'TS017111a7_rf': '0',
+      'TS017111a7_ct': '0',
+      'TS017111a7_pd': '0'
     }
   end
+
+  private
+
+  def debug(word, url, status_code, body)
+    STDERR.puts <<-DOC
+      [debug] #{'=' * 40}
+
+      word:         #{word}
+      url:          #{url}
+      status_code:  #{status_code}
+    DOC
+    STDERR.puts "body: `#{body}`" if ENV['NEBRIJA_DEBUG'].to_i == 2
+    STDERR.puts
+  end
 end

data/lib/nebrija/version.rb

@@ -1,7 +1,7 @@
 module Nebrija
   MAJOR = 1
-  MINOR = 0
-  PATCH = 9
+  MINOR = 1
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/script/cibuild

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -ex
+
+if [ "$TRAVIS_EVENT_TYPE" = "cron" ]; then
+  echo "=> running non mocked test as environment='cron'"
+  NO_MOCK=1 bundle exec rake test
+else
+  bundle exec rake test
+fi

data/test/mocks/cli_output

@@ -0,0 +1 @@
+Sentimiento hacia otra persona que naturalmente nos atrae y que, procurando reciprocidad en     el deseo de unión, nos completa, alegra y da energía para convivir, comunicarnos y crear

data/test/test_rae.rb

@@ -1,31 +1,34 @@
 require 'test_helper'
 
 class TestRae < Minitest::Test
+  def setup
+    WebMock.disable! if ENV['NO_MOCK']
+  end
+
   def test_cli_basic
     word = 'amor'
-    stub_request(:post, "#{Rae::SEARCH_URL}?w=#{word}")
-      .to_return(status: 200, body: mock('single'))
+    stub(word, :single)
 
     out, = capture_io do
       Nebrija.cli(word)
     end
 
-    assert_match mock_cli.gsub(/\s+/, ''), out.gsub(/\s+/, '')
+    assert_match mock(:cli_output).gsub(/\s+/, ''), out.gsub(/\s+/, '')
   end
 
   def test_error_basic
-    stub_request(:post, "#{Rae::SEARCH_URL}?w=wadus")
-      .to_return(status: 200, body: mock('error'))
+    word = 'wadus'
+    stub(word, :error)
 
-    search = Rae.new.search('wadus')
+    search = Rae.search('wadus')
     assert_equal search[:status], 'error'
   end
 
   def test_single_basic
-    stub_request(:post, "#{Rae::SEARCH_URL}?w=amor")
-      .to_return(status: 200, body: mock('single'))
+    word = 'amor'
+    stub(word, :single)
 
-    search = Rae.new.search('amor')
+    search = Rae.search(word)
     assert_equal 'success', search[:status]
     assert_equal 'single', search[:type]
 
@@ -34,10 +37,10 @@ class TestRae < Minitest::Test
   end
 
   def test_multiple_basic
-    stub_request(:post, "#{Rae::SEARCH_URL}?w=banco")
-      .to_return(status: 200, body: mock('multiple'))
+    word = 'banco'
+    stub(word, :multiple)
 
-    search = Rae.new.search('banco')
+    search = Rae.search(word)
     assert_equal 'success', search[:status]
     assert_equal 'multiple', search[:type]
     assert_equal 4, search[:response].length
@@ -47,12 +50,12 @@ class TestRae < Minitest::Test
 
   private
 
-  def mock(mock_name)
-    File.read("#{File.expand_path(File.dirname(__FILE__))}/mocks/#{mock_name}.html")
+  def stub(word, mock_name)
+    stub_request(:post, "#{Rae::SEARCH_URL}?w=#{word}")
+      .to_return(status: 200, body: mock(mock_name))
   end
 
-  def mock_cli
-    # rubocop:disable LineLength
-    'Sentimiento hacia otra persona que naturalmente nos atrae y que, procurando reciprocidad en el deseo de unión, nos completa, alegra y da energía para convivir, comunicarnos y crear'
+  def mock(mock_name)
+    File.read("#{File.expand_path(File.dirname(__FILE__))}/mocks/#{mock_name}")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nebrija
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - javierhonduco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -102,10 +102,12 @@ files:
 - lib/nebrija/rae.rb
 - lib/nebrija/version.rb
 - nebrija.gemspec
-- test/mocks/error.html
-- test/mocks/multiple.html
-- test/mocks/noscript.html
-- test/mocks/single.html
+- script/cibuild
+- test/mocks/cli_output
+- test/mocks/error
+- test/mocks/multiple
+- test/mocks/noscript
+- test/mocks/single
 - test/test_helper.rb
 - test/test_rae.rb
 homepage: http://rubygems.org/gems/nebrija