alchemy-api-rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fe783161cfc11d94ad31463753b5934d0699d30
-  data.tar.gz: fc79c8485c2d26797f58ddba5de5c9b27e06dcf5
+  metadata.gz: c725dda0bc9ef0485b08b94e4002de54d7101b1f
+  data.tar.gz: bf91f17e97f5f0fde36fb8dcb0a1ca96739fdcc0
 SHA512:
-  metadata.gz: 7ee9b8997c5c4cae595ba7b3fd8ab2e5c56299a5b1474203e36309f5bf77b406742f314a2e75c1f75c8a508d38ced446ea74e9fb2d6ae170175e991c2f435e79
-  data.tar.gz: c2d22edcf5ba13d52f586a8c8837277999c6ee69f270deba3c46c9a891ac16b18e2792df7f99e69812a4396861cb75dc02011e0efdec31a91aa3c618488e7ebc
+  metadata.gz: 2ae196f15536e7307688a104dd6a5a495f98df59ab0288572d94962440e5a0067fb73f8a980977ce561276f2054d9f9503260595ccc16700a4c055bc257d0858
+  data.tar.gz: 66a00d022c1640553078815b35369ef0f150a384725ec52800de06881a943b79aa35922e2ee0ac50b8422d65749ce2bf25726946bc1f85893450ed7b721f5d21

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - alchemy-api-rb.gemspec
+    - vendor/**/*
+
+Documentation:
+  # don't require classes to be documented
+  Enabled: false
+
+Encoding:
+  # no need to always specify encoding
+  Enabled: false
+
+LineLength:
+  # just one more character please
+  Max: 80
+

data/.travis.yml

@@ -1,13 +1,18 @@
 language: ruby
+
+cache: bundler
+
 rvm:
   - 2.1.2
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby
+  - jruby-19mode
+
 env:
   global:
     secure: CubibQsfHYol2AlaplZH5Q1AiGJY/tn9pR9A06xrK28YQc4TLeEE4vrzntBiMd7UrgHjJ07gDshSF5muoCpLscuC0sK7LqHVA62iPYuIiK+9gd6+OPgnJ+3Rw5MMJLuboHkPwKHIMgCArtg+xPCHASxt4eK59wny80d9b7ifnnw=
-cache: bundler
+
 addons:
   code_climate:
     repo_token: 412bc15e5c0d57c3381d70da56b468979f649edc02f3078f697d8f66334b3fc5

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Next Release
+
+* Your contribution here.
+* [#15](https://github.com/technekes/alchemy-api-rb/pull/15): Author extraction now returns a String (like title extraction) instead of a Hash - [@reshleman](https://github.com/reshleman).
+
+# 0.4.0 (08/31/2014)
+
+#### Features
+
+* [#13](https://github.com/technekes/alchemy-api-rb/pull/13): Adds targeted sentiment analysis endpoint - [@vaibhao90](https://github.com/vaibhao90) and [@johnallen3d](https://github.com/johnallen3d).
+
+# 0.3.0 (7/27/2014)
+
+#### Features
+
+* [#12](https://github.com/technekes/alchemy-api-rb/pull/12): Adds support for the image tagging endpoint - [@fdeschenes](https://github.com/fdeschenes).
+* [#11](https://github.com/technekes/alchemy-api-rb/pull/11): Adds support for the title extraction endpoint - [@garretthunyadi](https://github.com/garretthunyadi).
+* [#10](https://github.com/technekes/alchemy-api-rb/pull/10): Adds support for the taxonomy endpoint - [@garretthunyadi](https://github.com/garretthunyadi).
+
+#### Fixes
+
+* [#9](https://github.com/technekes/alchemy-api-rb/pull/9): Set excon adapter on faraday initialization - [@AdamFerguson](https://github.com/AdamFerguson).
+

data/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing to alchemy-api-rb
+
+alchemy-api-rb is work of [several contributors](https://github.com/technekes/alchemy-api-rb/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/technekes/alchemy-api-rb/pulls), [propose features and discuss issues](https://github.com/technekes/alchemy-api-rb/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/technekes/alchemy-api-rb) and check out your copy.
+
+```
+git clone https://github.com/contributor/alchemy-api-rb.git
+cd alchemy-api-rb
+git remote add upstream https://github.com/technekes/alchemy-api-rb.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+ALCHEMY_API_KEY="this-is-my-40-character-key" bundle exec rake test
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/](spec/).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `ALCHEMY_API_KEY="this-is-my-40-character-key" bundle exec rake test` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/technekes/alchemy-api-rb/compare and select your feature branch. Click the 'Create pull request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#13](https://github.com/technekes/alchemy-api-rb/pull/13): Adds targeted sentiment analysis endpoint - [@vaibhao90](https://github.com/vaibhao90) and [@johnallen3d](https://github.com/johnallen3d).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/README.md

@@ -32,7 +32,9 @@ Not yet implemented API's:
 
 Add this line to your application's Gemfile:
 
-    gem 'alchemy-api-rb', :require => 'alchemy_api'
+```ruby
+gem 'alchemy-api-rb', :require => 'alchemy_api'
+```
 
 And then execute:
 
@@ -48,35 +50,47 @@ You'll need to [request an API Key](http://www.alchemyapi.com/api/register.html)
 
 Set your API Key in an initializer or something similar:
 
-    AlchemyAPI.key = "xxxxxxxxxxxxxxxxxx"
+```ruby
+AlchemyAPI.key = "xxxxxxxxxxxxxxxxxx"
+```
 
 You may set the key along with other config settings:
 
-    AlchemyAPI.configure do |config|
-      config.apikey = "xxxxxxxxxxxxxxxxxx"
-      config.output_mode = :xml # not yet supported
-    end
+```ruby
+AlchemyAPI.configure do |config|
+  config.apikey = "xxxxxxxxxxxxxxxxxx"
+  config.output_mode = :xml # not yet supported
+end
+```
 
 Request keyword extraction for a string of text:
 
-    results = AlchemyAPI.search(:keyword_extraction, :text => "hello world")
+```ruby
+results = AlchemyAPI.search(:keyword_extraction, text: "hello world")
+```
 
 or
 
-    results = AlchemyAPI::KeywordExtraction.new.search(:url => "http://www.alchemyapi.com/")
+```ruby
+results = AlchemyAPI::KeywordExtraction.new.search(url: 'http://www.alchemyapi.com/')
+```
 
 or
 
-    results = AlchemyAPI::KeywordExtraction.new.search(:html => "<html><body>lorem ipsum</body></html>")
+```ruby
+results = AlchemyAPI::KeywordExtraction.new.search(html: "<html><body>lorem ipsum</body></html>")
+```
 
 Results for keyword extraction are returned as a array of keywords:
 
-    [
-      {
-             "text" => "lorem ipsum",
-        "relevance" => "0.993164"
-      }
-    ]
+```ruby
+[
+  {
+         "text" => 'lorem ipsum',
+    "relevance" => "0.993164"
+  }
+]
+```
 
 ## Testing
 
@@ -96,11 +110,9 @@ If you would like to expirement with the API you can run the `console` rake task
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+alchemy-api-rb is work of several contributors. You're encouraged to submit pull requests, propose features and discuss issues.
+
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 

data/Rakefile

@@ -1,11 +1,14 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-task :default => [:test]
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :test]
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
+  t.libs.push 'lib'
   t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end

data/alchemy-api-rb.gemspec

@@ -16,14 +16,15 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = AlchemyAPI::VERSION
 
-  gem.add_dependency             'faraday',             '~> 0.8.x'
-  gem.add_dependency             'excon',               '~> 0.28.x'
+  gem.add_dependency             'faraday',             '~> 0.8.0'
+  gem.add_dependency             'excon',               '~> 0.28.0'
 
-  gem.add_development_dependency 'minitest',            '~> 5.4.x'
-  gem.add_development_dependency 'pry',                 '~> 0.10.x'
-  gem.add_development_dependency 'rake',                '~> 10.3.x'
-  gem.add_development_dependency 'minitest-reporters',  '~> 1.0.x'
-  gem.add_development_dependency 'vcr',                 '~> 2.3.x'
-  gem.add_development_dependency 'webmock',             '~> 1.18.x'
-  gem.add_development_dependency 'coveralls',           '~> 0.7.x'
+  gem.add_development_dependency 'minitest',            '~> 5.4.0'
+  gem.add_development_dependency 'pry',                 '~> 0.10.0'
+  gem.add_development_dependency 'rake',                '~> 10.3.0'
+  gem.add_development_dependency 'minitest-reporters',  '~> 1.0.0'
+  gem.add_development_dependency 'vcr',                 '~> 2.3.0'
+  gem.add_development_dependency 'webmock',             '~> 1.18.0'
+  gem.add_development_dependency 'coveralls',           '~> 0.7.0'
+  gem.add_development_dependency 'rubocop',             '~> 0.25.0'
 end

data/lib/alchemy-api/author_extraction.rb

@@ -13,9 +13,7 @@ module AlchemyAPI
     end
 
     def indexer
-      nil
+      'author'
     end
   end
 end
-
-

data/lib/alchemy-api/base.rb

@@ -20,7 +20,7 @@ module AlchemyAPI
         indexer ? parsed[indexer] : parsed
       when :xml
       when :rdf
-        raise NotImplementedError.new
+        fail NotImplementedError
       end
     end
 
@@ -33,11 +33,8 @@ module AlchemyAPI
     def check_options(opts)
       @options = opts
 
-      raise MissingOptionsError.new unless options && options.keys
-
-      unless supported_search_types.include?(mode)
-        raise UnsupportedSearchMode.new
-      end
+      fail MissingOptionsError unless options && options.keys
+      fail UnsupportedSearchMode unless supported_search_types.include?(mode)
     end
 
     def connection
@@ -55,14 +52,14 @@ module AlchemyAPI
         return type if options.keys && options.keys.include?(type)
       end
 
-      raise MissingOptionsError.new
+      fail MissingOptionsError
     end
 
     def method_prefix
       case mode
-      when :text then "Text"
-      when :url then "URL"
-      when :html then "HTML"
+      when :text then 'Text'
+      when :url  then 'URL'
+      when :html then 'HTML'
       end
     end
 
@@ -77,4 +74,3 @@ module AlchemyAPI
     end
   end
 end
-

data/lib/alchemy-api/concept_tagging.rb

@@ -9,8 +9,7 @@ module AlchemyAPI
     private
 
     def indexer
-      "concepts"
+      'concepts'
     end
   end
 end
-

data/lib/alchemy-api/config.rb

@@ -13,7 +13,7 @@ module AlchemyAPI
 
     def self.default_options
       {
-        :outputMode => output_mode
+        outputMode: output_mode
       }
     end
 
@@ -22,13 +22,13 @@ module AlchemyAPI
     end
 
     def self.output_mode=(value)
-      raise InvalidOutputMode.new unless valid_output_modes.include?(value.to_s)
+      fail InvalidOutputMode unless valid_output_modes.include?(value.to_s)
 
       @output_mode = value
     end
 
     def self.valid_output_modes
-      ["xml", "json", "rdf", "rel-tag", "rel-tag-raw"]
+      ['xml', 'json', 'rdf', 'rel-tag', 'rel-tag-raw']
     end
   end
 end

data/lib/alchemy-api/entity_extraction.rb

@@ -9,7 +9,7 @@ module AlchemyAPI
     private
 
     def indexer
-      "entities"
+      'entities'
     end
   end
 end

data/lib/alchemy-api/image_tagging.rb

@@ -13,7 +13,7 @@ module AlchemyAPI
     end
 
     def indexer
-      "imageKeywords"
+      'imageKeywords'
     end
   end
 end

data/lib/alchemy-api/keyword_extraction.rb

@@ -9,7 +9,7 @@ module AlchemyAPI
     private
 
     def indexer
-      "keywords"
+      'keywords'
     end
   end
 end