nebrija 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f46b3cc778fe91eabc180c2133a3c162c4ddde30
-  data.tar.gz: fc7903017f8e16fc4382c0395966b4e83e685211
+  metadata.gz: e88cf6582f87d79939a6875adb7fa7c577f00316
+  data.tar.gz: c9f8856abd41c69a0990821261f1fcc99134c52c
 SHA512:
-  metadata.gz: c3409c22d44eb566f053be780005ac767670f3b2a0243803f2ded9af7e40660bcd5d323093e506f773ee219aa95a6ef3d0bede596346993fd97659bce65e8854
-  data.tar.gz: e47f81c8dd599fc803877c157498d8ddbb8c211776dc3782889d4551c53f413c6c95aa355d0e04f9fb23dd347b6f6951887e6cbbf37b428c4be918879342eeb5
+  metadata.gz: 867a51af868ec5cd7fc8e1df3967162948b803931ea76d1c8f38fec815b4ab3abc0e9b8c02c39fa64d1dd0f86024491f643e297af740731118a06b87cbfa8305
+  data.tar.gz: b8d59ebecf6ccf5c7d12d0054d597408f62ecebad183d474bf71f15a6eb1b2d361aff054d13e818b4885e620398a2be541bb8230a20c1c925deea4105f332a30

data/.gitignore

@@ -7,6 +7,7 @@
 coverage
 InstalledFiles
 lib/bundler/man
+vendor/
 pkg
 rdoc
 spec/reports

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 85
+Metrics/MethodLength:
+  Max: 20
+Documentation:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -1,2 +1,6 @@
 sudo: false
 language: ruby
+rvm:
+  - 2.3.1
+cache: bundler
+

data/README.md

@@ -1,7 +1,6 @@
 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)
 
@@ -17,45 +16,36 @@ API
 ---
 ```ruby
 require 'nebrija'
-res = Rae.new.search('word/id') 
+res = Rae.new.search('word/id')
 puts res # prints the results
 ```
 
 `HTTPRae` returns a hash where the key `status` can be `error`|`success`.
 
-If the request is succesful, the key `type` indicates wheter the result type is a single word or multiple  with `single`|`multiple`.
+If the request is succesful, 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 is an array.
+The response data can be found in the `response` key which holds an array.
+
+The response data is formatted as shown in the [nebrija/cli](https://github.com/javierhonduco/nebrija/blob/master/lib/nebrija/cli.rb) file:
 
-The response data is formatted as shown below:
-* Single responses
-```ruby
-[{:word=>"banca", :id=>"N4sDS8D9sDXX2ydchkDs"}, {:word=>"bancar", :id=>"MHpGWYJ6YDXX2bw9Ghwm"}, {:word=>"bance", :id=>"dkcRaDoJTDXX2mbtZ21J"}, {:word=>"banco", :id=>"E0yO6yORQDXX2M4zQtJ3"}]
-```
-* Multiple responses
-```ruby
-[{:word=>"A-1.", :etymology=>"(Del gr. ἀ-, priv.).", :meanings=>[{:meaning=>"Carece de significación precisa. Amatar. Asustar. Avenar.", :meta=>"pref."}]}, {:word=>"A1.", :etymology=> nil, :meanings=>[{:meaning=>"Primera letra del abecedario español y del orden latino internacional, que representa un fonema vocálico abierto y central.", :meta=>"f."}, {:meaning=>"Signo de la proposición universal afirmativa.", :meta=>"Fil."}]}, {:word=>"~ por ~ y b por b.", :etymology=> nil, :meanings=>[{:meaning=>"punto por punto.", :meta=>"adv."}]}, {:word=>"A-2.", :etymology=> nil, :meanings=>[{:meaning=>"Denota privación o negación. Acromático. Ateísmo. Ante vocal toma la forma an-. Anestesia. Anorexia.", :meta=>"pref."}]}]
-```
 CLI searching
 ---------
 ```bash
 $ nebrija <word>
 ```
 
+Maybe you are lazy and want to add an alias to `rae` or `es` like I do :)
+
 Friend projects/ project 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) 
+* [Dulcinea: a nebrija frontend](https://github.com/javierhonduco/dulcinea)
 
 TODO
 ----
-* Check it works properly.
-* Doc. (return, hacks...)
-* Improve the code.
-* Add bulk search.
-* Set a request timeout.
-* ~~Search by id.~~
-* ~~Handle errors.~~
-* ~~Get it working without using cURL directly.~~
-* ~~Improve the API.~~
-* ~~Add Gemfile.~~
+* Improve the API.
+* Update clients to use new API.
+* Fix multiple responses.
+* Better doc.
+* Mockless testing.
+* Make the parser more readable.

data/Rakefile

@@ -1,4 +1,8 @@
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+RuboCop::RakeTask.new
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -6,15 +10,4 @@ Rake::TestTask.new do |t|
 end
 
 desc 'Run tests'
-task :default => :test
-
-desc 'Publish'
-task :publish do
-  $: << 'lib' and require 'nebrija/version'
-  version = Nebrija::VERSION
-
-  `gem build nebrija.gemspec`
-  `gem install nebrija-#{version}.gem`
-  `gem push nebrija-#{version}.gem`
-  `rm *.gem`
-end
+task default: :test

data/bin/debug

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-$: << 'lib'
-
 require 'json'
 require 'pp'
 require 'nebrija'

data/bin/nebrija

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << 'lib'
-
 require 'json'
 require 'nebrija/cli'
 
-Nebrija::cli(ARGV.first)
+Nebrija.cli(ARGV.first)

data/lib/nebrija/cli.rb

@@ -2,10 +2,9 @@ require 'json'
 require 'nebrija'
 
 module Nebrija
-  def self.cli word
-    if word.nil?
-      abort 'Type a word `$ nebrija amor`'
-    end
+  # rubocop:disable MethodLength
+  def self.cli(word)
+    abort 'Type a word `$ nebrija amor`' if word.nil?
 
     result = Rae.new.search(word)
     status = result[:status]

data/lib/nebrija/parser.rb

@@ -1,24 +1,23 @@
 require 'nokogiri'
 
 class Parser
-
   META_REGEX = /^([a-zA-Z]{1,4}+\.[ ]{1,2})+/
 
-  def initialize(rae_data, word)
+  def initialize(rae_data, _word)
     @doc = Nokogiri::HTML(rae_data)
   end
 
   def parse
     if valid?
       {
-        :status => 'success',
-        :type => single? ? 'single' : 'multiple',
-        :response => parse_single
+        status: 'success',
+        type: single? ? 'single' : 'multiple',
+        response: parse_single
       }
     else
       {
-        :status => 'error',
-        :message => 'Word/id does not exist. Sorry.'
+        status: 'error',
+        message: 'Word/id does not exist. Sorry.'
       }
     end
   end
@@ -27,13 +26,13 @@ class Parser
 
   def parse_single
     response = {
-      :core_meanings => [],
-      :other_meanings => []
+      core_meanings: [],
+      other_meanings: []
     }
 
-    response[:word] = @doc.css('header').
-      inner_text.sub('.', '').
-      capitalize!
+    response[:word] = @doc.css('header')
+                          .inner_text.sub('.', '')
+                          .capitalize!
 
     @doc.css('body > div > article > p').each_with_index do |entry, index|
       if index.zero?
@@ -42,7 +41,7 @@ class Parser
       elsif entry['class'] =~ /j[0-9]*/
         # Parsing first meaning
         response[:core_meanings] << metadata(entry.inner_text)
-      elsif entry['class'] == 'm' || entry['class'] =~/k[0-9]*/
+      elsif entry['class'] == 'm' || entry['class'] =~ /k[0-9]*/
         # Parsing other meanings
         #   k: expression with 1 element
         #   m: is the meaning with >= elements
@@ -54,7 +53,7 @@ class Parser
     clean! response
   end
 
-  def clean! response
+  def clean!(response)
     parsed_meanings = []
     state = :EXPR
     temp = nil
@@ -62,12 +61,10 @@ class Parser
     response[:other_meanings].each do |type, text|
       state = :EXPR if type == :expression
       if state == :EXPR
-        unless temp.nil?
-          parsed_meanings << temp
-        end
+        parsed_meanings << temp unless temp.nil?
         temp = {
-          :expression => text,
-          :meanings => []
+          expression: text,
+          meanings: []
         }
         state = :MEAN
       elsif state == :MEAN
@@ -87,13 +84,13 @@ class Parser
     !@doc.css('article').length.zero? # delete_pending?
   end
 
-  def metadata text
+  def metadata(text)
     # TODO
     # The idea would be to split the text in metadata
     # and real text. It's seems quite tricky.
     {
-      :meaning => text,
-      :meta => nil
+      meaning: text,
+      meta: nil
     }
   end
 

data/lib/nebrija/rae.rb

@@ -1,9 +1,12 @@
-require 'uri'
-require 'typhoeus'
+require 'cgi'
+require 'net/http'
 
 class Rae
-  SEARCH_URL = 'http://dle.rae.es/srv/fetch'
-  USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36'
+  SEARCH_URL    = 'http://dle.rae.es/srv/fetch'.freeze
+  # rubocop:disable LineLength
+  USER_AGENT    = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36'.freeze
+  OPEN_TIMEOUT  = 2
+  READ_TIMEOUT  = 3
 
   def search(word)
     Parser.new(query(word), word).parse
@@ -12,18 +15,15 @@ class Rae
   private
 
   def query(word)
-    url = URI.escape("#{SEARCH_URL}?w=#{word}".encode('iso-8859-1'))
-    headers = {
-      'User-Agent' => USER_AGENT,
-      'Cookie' => 'TS017111a7=017ccc203c0b977befd5d97f3b75b80f201991f161b0d246f45e53dac0967ac4e4acfd7161'
-    }
+    uri = URI "#{SEARCH_URL}?w=#{CGI.escape(word)}".encode('iso-8859-1')
 
-    response = Typhoeus::Request.get(
-      url,
-      headers: headers,
-      accept_encoding: 'gzip',
-    )
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http.open_timeout = OPEN_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
 
-    response.body
+      request = Net::HTTP::Get.new uri
+      response = http.request request
+      response.body
+    end
   end
 end

data/lib/nebrija/version.rb

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

data/nebrija.gemspec

@@ -1,27 +1,27 @@
-$: << 'lib' and require 'nebrija/version'
+$LOAD_PATH << 'lib' && require('nebrija/version')
 
 Gem::Specification.new do |s|
   s.name = 'nebrija'
   s.version = Nebrija::VERSION
   s.executables << 'nebrija'
 
-  s.authors = ['@javierhonduco']
+  s.authors = ['javierhonduco']
   s.date = Time.now.utc.strftime('%Y-%m-%d')
-  s.description = 'A gem to access the rae dictionary'
+  s.description = 'A gem to access the RAE dictionary'
   s.email = 'javierhonduco@gmail.com'
   s.files = `git ls-files`.split($/)
   s.test_files = ['test/test_rae.rb']
   s.homepage = 'http://rubygems.org/gems/nebrija'
 
   s.require_paths = ['lib']
-  s.summary = 'This gem provides access to the rae webpage'
+  s.summary = 'This gem makes easy accessing RAE webpage in a programmatic way'
 
-  s.add_dependency('nokogiri')
-  s.add_dependency('typhoeus', '~> 0')
+  s.add_dependency('nokogiri', '~> 1.6.8')
 
-  s.add_development_dependency('rake', '~> 0')
-  s.add_development_dependency('minitest', '~> 5')
-  s.add_development_dependency('webmock', '~> 1.18.0', '>= 1.18.0')
+  s.add_development_dependency('rake', '~> 11.2.2')
+  s.add_development_dependency('webmock', '~> 2.1.0')
+  s.add_development_dependency('minitest', '~> 5.9.0')
+  s.add_development_dependency('rubocop', '~> 0.41.1')
 
   s.license = 'MIT'
 end

data/test/test_helper.rb

@@ -2,3 +2,4 @@ require 'rubygems'
 require 'minitest/autorun'
 require 'webmock/minitest'
 require 'nebrija'
+require 'nebrija/cli'

data/test/test_rae.rb

@@ -1,18 +1,29 @@
 require 'test_helper'
 
 class TestRae < Minitest::Test
+  def test_cli_basic
+    word = 'amor'
+    stub_request(:get, "#{Rae::SEARCH_URL}?w=#{word}")
+      .to_return(status: 200, body: mock('single'))
+
+    out, = capture_io do
+      Nebrija.cli(word)
+    end
+
+    assert_match mock_cli.gsub(/\s+/, ''), out.gsub(/\s+/, '')
+  end
 
   def test_error_basic
-    stub_request(:get, "#{Rae::SEARCH_URL}?w=wadus").
-      to_return(:status => 200, :body => mock('error'))
+    stub_request(:get, "#{Rae::SEARCH_URL}?w=wadus")
+      .to_return(status: 200, body: mock('error'))
 
     search = Rae.new.search('wadus')
     assert_equal search[:status], 'error'
   end
 
   def test_single_basic
-    stub_request(:get, "#{Rae::SEARCH_URL}?w=amor").
-      to_return(:status => 200, :body => mock('single'))
+    stub_request(:get, "#{Rae::SEARCH_URL}?w=amor")
+      .to_return(status: 200, body: mock('single'))
 
     search = Rae.new.search('amor')
     assert_equal 'success', search[:status]
@@ -23,8 +34,8 @@ class TestRae < Minitest::Test
   end
 
   def test_multiple_basic
-    stub_request(:get, "#{Rae::SEARCH_URL}?w=banco").
-      to_return(:status => 200, :body => mock('multiple'))
+    stub_request(:get, "#{Rae::SEARCH_URL}?w=banco")
+      .to_return(status: 200, body: mock('multiple'))
 
     search = Rae.new.search('banco')
     assert_equal 'success', search[:status]
@@ -39,4 +50,10 @@ class TestRae < Minitest::Test
   def mock(mock_name)
     File.read("#{File.expand_path(File.dirname(__FILE__))}/mocks/#{mock_name}.html")
   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
+    '
+  end
 end

metadata

@@ -1,92 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: nebrija
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
-- "@javierhonduco"
+- javierhonduco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 11.2.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.9.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 0.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
-description: A gem to access the rae dictionary
+        version: 0.41.1
+description: A gem to access the RAE dictionary
 email: javierhonduco@gmail.com
 executables:
 - nebrija
@@ -94,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -132,9 +127,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: This gem provides access to the rae webpage
+summary: This gem makes easy accessing RAE webpage in a programmatic way
 test_files:
 - test/test_rae.rb