alchemy-api-rb 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31277e5e90e5ae62da0fefb394183353d4e33ced
-  data.tar.gz: d19aa8079f9202e4b458d369cec03f49cf72a6be
+  metadata.gz: 68d09f08382b94eb3e56c2384d8ede01e31adac3
+  data.tar.gz: e464c34e50a1ca8247d99741141ae4ef406fe096
 SHA512:
-  metadata.gz: 04255bbc5570da2d2da96c51718bbde33affd0f58c7738300de5f32e15cfa8e7df4fcd8393e57d912e6ce4d9d8e27619fb9edaef778278d2ab24bcf24121dd19
-  data.tar.gz: adcb2ac528160d034d9950270e3b0afad28ec6af1c8953dc72430bfdb6bb8a8218c5c63a41980382fe33b6954dade0767f93b8ea298901961d1a030e9bb579e1
+  metadata.gz: e1b35fe6564153d24501daa78b60311a6b921b7fcc537b9b154ddad82578f0dd3fcd96dd4c760a2858cf79cc8618b48c3f5cae3f78bd20fdc1916ad63d50701c
+  data.tar.gz: 0f81d3473b2da94fd5c40404d3faca9e3d7fb2e38de8ead5732b46b14bb40ab6af87f83c4b45056726e4d0fb1b26ac19d75f942812c4c35c170d84a05701e31a

data/.travis.yml

@@ -1,11 +1,13 @@
 language: ruby
 rvm:
-  # - 1.8.7
-  # - 1.9.2
+  - 2.1.2
+  - 2.0.0
   - 1.9.3
-  # - jruby-18mode # JRuby in 1.8 mode
-  # - jruby-19mode # JRuby in 1.9 mode
-  # - rbx-18mode
-  # - rbx-19mode
-# uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+  - jruby
+env:
+  global:
+    secure: CubibQsfHYol2AlaplZH5Q1AiGJY/tn9pR9A06xrK28YQc4TLeEE4vrzntBiMd7UrgHjJ07gDshSF5muoCpLscuC0sK7LqHVA62iPYuIiK+9gd6+OPgnJ+3Rw5MMJLuboHkPwKHIMgCArtg+xPCHASxt4eK59wny80d9b7ifnnw=
+cache: bundler
+addons:
+  code_climate:
+    repo_token: 412bc15e5c0d57c3381d70da56b468979f649edc02f3078f697d8f66334b3fc5

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in alchemy-api-rb.gemspec
 gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', group: :test, require: nil
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,18 +1,23 @@
 # AlchemyAPI
 
 [![Build Status](https://secure.travis-ci.org/technekes/alchemy-api-rb.png?branch=master)](http://travis-ci.org/technekes/alchemy-api-rb)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/technekes/alchemy-api-rb)
+[![Code Climate](https://codeclimate.com/github/technekes/alchemy-api-rb.png)](https://codeclimate.com/github/technekes/alchemy-api-rb)
+[![Coverage Status](https://img.shields.io/coveralls/technekes/alchemy-api-rb.svg)](https://coveralls.io/r/technekes/alchemy-api-rb)
+[![Dependency Status](https://gemnasium.com/connexio-labs/omniauth-connexio.png)](https://gemnasium.com/connexio-labs/omniauth-connexio)
+[![Gem Version](https://badge.fury.io/rb/alchemy-api-rb.png)](http://badge.fury.io/rb/alchemy-api-rb)
 
 This is a Ruby Client Library that provides access to the [Alchemy text mining API](http://www.alchemyapi.com/). The current version targets the following API's:
 
 * Keyword Extraction
 * Text Extraction
 * Entity Extraction
+* Relation Extraction
 * Sentiment Analysis
 * Concept Tagging
 * Text Categorization
 * Language Detection
 * Author Extraction
+* Image Tagging
 
 Not yet implemented API's:
 
@@ -45,7 +50,7 @@ Set your API Key in an initializer or something similar:
 You may set the key along with other config settings:
 
     AlchemyAPI.configure do |config|
-      config.key = "xxxxxxxxxxxxxxxxxx"
+      config.apikey = "xxxxxxxxxxxxxxxxxx"
       config.output_mode = :xml # not yet supported
     end
 
@@ -72,9 +77,13 @@ Results for keyword extraction are returned as a array of keywords:
 
 ## Testing
 
-The spec_helper is looking for your API Key in the project root in a file named `.keys`. Put just your key in there and then you can run:
+The specs are expecting your API Key as an environment variable named `ALCHEMY_API_KEY`. You can export it locally or prepend the test command like so:
 
-    rake test
+    ALCHEMY_API_KEY="this-is-my-40-character-key" bundle exec rake test
+
+If you would like to expirement with the API you can run the `console` rake task and use the commands above to set the API Key issue search commands:
+
+    bundle exec rake console
 
 ## TODO
 
@@ -89,3 +98,7 @@ The spec_helper is looking for your API Key in the project root in a file named
 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
+
+## License
+
+MIT License. See LICENSE for details.

data/Rakefile

@@ -9,3 +9,11 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end
+
+desc 'Open a pry session preloaded with this library'
+task :console do
+  require 'pry'
+  require './lib/alchemy_api.rb'
+  ARGV.clear
+  Pry.start
+end

data/alchemy-api-rb.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Provides access to the Alchemy text mining API - http://www.alchemyapi.com/}
   gem.summary       = %q{This is a ruby client library that provides access to the Alechemy text mining API. The initial version targets the keyword extraction api specificaly, with other implementations to follow.}
   gem.homepage      = "https://github.com/technekes/alchemy-api-rb"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,12 +16,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = AlchemyAPI::VERSION
 
-  gem.add_dependency             'faraday',             '~> 0.8.1'
-  gem.add_dependency             'excon',               '~> 0.28.0'
+  gem.add_dependency             'faraday',             '~> 0.8.x'
+  gem.add_dependency             'excon',               '~> 0.28.x'
 
-  gem.add_development_dependency 'minitest',            '~> 3.1.0'
-  gem.add_development_dependency 'rake',                '~> 0.9.2'
-  gem.add_development_dependency 'turn',                '~> 0.9.5'
-  gem.add_development_dependency 'vcr',                 '~> 2.2.0'
-  gem.add_development_dependency 'fakeweb',             '~> 1.3.0'
+  gem.add_development_dependency 'minitest',            '~> 3.1.x'
+  gem.add_development_dependency 'pry',                 '~> 0.10.x'
+  gem.add_development_dependency 'rake',                '~> 10.3.x'
+  gem.add_development_dependency 'turn',                '~> 0.9.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'
 end

data/lib/alchemy-api/base.rb

@@ -41,7 +41,9 @@ module AlchemyAPI
     end
 
     def connection
-      @connection ||= Faraday.new(url: BASE_URL)
+      @connection ||= Faraday.new(url: BASE_URL) do |builder|
+        builder.adapter :excon
+      end
     end
 
     def supported_search_types

data/lib/alchemy-api/image_tagging.rb

@@ -0,0 +1,19 @@
+module AlchemyAPI
+  class ImageTagging < Base
+    Config.add_mode :image_tagging, self
+
+    def web_method
+      "#{method_prefix}GetRankedImageKeywords"
+    end
+
+    private
+
+    def supported_search_types
+      [:url]
+    end
+
+    def indexer
+      "imageKeywords"
+    end
+  end
+end

data/lib/alchemy-api/taxonomy.rb

@@ -0,0 +1,16 @@
+module AlchemyAPI
+  class Taxonomy < Base
+    Config.add_mode :taxonomy, self
+
+    def web_method
+      "#{method_prefix}GetRankedTaxonomy"
+    end
+
+    private
+
+    def indexer
+      "taxonomy"
+    end
+  end
+end
+

data/lib/alchemy-api/title_extraction.rb

@@ -0,0 +1,19 @@
+module AlchemyAPI
+  class TitleExtraction < Base
+    Config.add_mode :title_extraction, self
+
+    def web_method
+      "#{method_prefix}GetTitle"
+    end
+
+    private
+
+    def supported_search_types
+      [:url, :html]
+    end
+
+    def indexer
+      "title"
+    end
+  end
+end

data/lib/alchemy-api/version.rb

@@ -1,3 +1,3 @@
 module AlchemyAPI
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/alchemy_api.rb

@@ -3,6 +3,7 @@ require "alchemy-api/config"
 require "alchemy-api/base"
 require "alchemy-api/keyword_extraction"
 require "alchemy-api/text_extraction"
+require "alchemy-api/title_extraction"
 require "alchemy-api/entity_extraction"
 require "alchemy-api/sentiment_analysis"
 require "alchemy-api/relation_extraction"
@@ -10,8 +11,8 @@ require "alchemy-api/concept_tagging"
 require "alchemy-api/text_categorization"
 require "alchemy-api/language_detection"
 require "alchemy-api/author_extraction"
-
-Faraday.default_adapter = :excon
+require "alchemy-api/taxonomy"
+require "alchemy-api/image_tagging"
 
 module AlchemyAPI
   BASE_URL = "http://access.alchemyapi.com/calls/"

data/spec/base_spec.rb

@@ -7,6 +7,12 @@ describe AlchemyAPI::Base do
     it "creates a connection" do
       subject.send(:connection).wont_be_nil
     end
+
+    describe "#adapter" do
+      it "uses the excon adapter" do
+        subject.send(:connection).builder.handlers.must_include Faraday::Adapter::Excon
+      end
+    end
   end
 
   describe "#merge_options" do
@@ -17,4 +23,5 @@ describe AlchemyAPI::Base do
       subject.merged_options(opts).must_be :==, expected
     end
   end
+
 end

data/spec/image_tagging_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe AlchemyAPI, "image_tagging" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+
+  subject() { AlchemyAPI::ImageTagging.new }
+
+  describe "#search" do
+    {
+      :url => "http://demo1.alchemyapi.com/images/vision/emaxfpo.jpg"
+    }.each do |type,value|
+      [:json].each do |output_mode|
+        before do
+          AlchemyAPI::Config.output_mode = output_mode
+        end
+
+        describe "#{type} search with #{output_mode} results" do
+          it "returns an array of results" do
+            VCR.use_cassette("image_tagging_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+
+              result.must_be_instance_of Array
+            end
+          end
+
+          it "includes the keyword text and score" do
+            VCR.use_cassette("image_tagging_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)[0]
+
+              result["text"].wont_be_nil
+              result["score"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,21 @@
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'turn/autorun'
+require 'webmock/minitest'
 require 'vcr'
+require 'pry'
+require 'codeclimate-test-reporter'
+require 'coveralls'
+
+CodeClimate::TestReporter.start
+Coveralls.wear!
 
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/alchemy_api'))
 
-API_KEY = File.read('./.keys').chomp
+API_KEY = ENV['ALCHEMY_API_KEY']
 
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/vcr_cassettes'
-  c.hook_into :fakeweb
+  c.hook_into :webmock
   c.filter_sensitive_data("ALCHEMY_KEY") { API_KEY }
 end

data/spec/vcr_cassettes/image_tagging_basic_url_json_search.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/url/URLGetRankedImageKeywords
+    body:
+      encoding: US-ASCII
+      string: apikey=ALCHEMY_KEY&url=http://demo1.alchemyapi.com/images/vision/emaxfpo.jpg&outputMode=json
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message:
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 26 Jul 2014 20:48:53 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '521'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - '*, *'
+    body:
+      encoding: UTF-8
+      string: "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"http://demo1.alchemyapi.com/images/vision/emaxfpo.jpg\",\r\n
+        \   \"totalTransactions\": \"4\",\r\n    \"imageKeywords\": [\r\n        {\r\n
+        \           \"text\": \"cat\",\r\n            \"score\": \"0.999665\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"animal\",\r\n            \"score\":
+        \"0.574443\"\r\n        }\r\n    ]\r\n}\r\n"
+    http_version:
+  recorded_at: Sat, 26 Jul 2014 20:48:53 GMT
+recorded_with: VCR 2.9.2

metadata

@@ -1,113 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-api-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.x
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.28.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.28.x
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.1.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.1.x
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.x
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 10.3.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 10.3.x
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.x
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.x
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.18.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.18.x
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.7.x
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.7.x
 description: Provides access to the Alchemy text mining API - http://www.alchemyapi.com/
 email:
 - john.allen@technekes.com
@@ -115,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -128,12 +156,15 @@ files:
 - lib/alchemy-api/concept_tagging.rb
 - lib/alchemy-api/config.rb
 - lib/alchemy-api/entity_extraction.rb
+- lib/alchemy-api/image_tagging.rb
 - lib/alchemy-api/keyword_extraction.rb
 - lib/alchemy-api/language_detection.rb
 - lib/alchemy-api/relation_extraction.rb
 - lib/alchemy-api/sentiment_analysis.rb
+- lib/alchemy-api/taxonomy.rb
 - lib/alchemy-api/text_categorization.rb
 - lib/alchemy-api/text_extraction.rb
+- lib/alchemy-api/title_extraction.rb
 - lib/alchemy-api/version.rb
 - lib/alchemy_api.rb
 - spec/alchemy_api_spec.rb
@@ -141,6 +172,7 @@ files:
 - spec/base_spec.rb
 - spec/concept_tagging_spec.rb
 - spec/entity_extraction_spec.rb
+- spec/image_tagging_spec.rb
 - spec/keyword_extraction_spec.rb
 - spec/language_detection_spec.rb
 - spec/relation_extraction_spec.rb
@@ -158,6 +190,7 @@ files:
 - spec/vcr_cassettes/entity_basic_html_json_search.yml
 - spec/vcr_cassettes/entity_basic_text_json_search.yml
 - spec/vcr_cassettes/entity_basic_url_json_search.yml
+- spec/vcr_cassettes/image_tagging_basic_url_json_search.yml
 - spec/vcr_cassettes/keyword_basic_html_json_search.yml
 - spec/vcr_cassettes/keyword_basic_text_json_search.yml
 - spec/vcr_cassettes/keyword_basic_url_json_search.yml
@@ -173,7 +206,8 @@ files:
 - spec/vcr_cassettes/text_basic_html_json_search.yml
 - spec/vcr_cassettes/text_basic_url_json_search.yml
 homepage: https://github.com/technekes/alchemy-api-rb
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -181,17 +215,17 @@ 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.1.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This is a ruby client library that provides access to the Alechemy text mining
@@ -203,6 +237,7 @@ test_files:
 - spec/base_spec.rb
 - spec/concept_tagging_spec.rb
 - spec/entity_extraction_spec.rb
+- spec/image_tagging_spec.rb
 - spec/keyword_extraction_spec.rb
 - spec/language_detection_spec.rb
 - spec/relation_extraction_spec.rb
@@ -220,6 +255,7 @@ test_files:
 - spec/vcr_cassettes/entity_basic_html_json_search.yml
 - spec/vcr_cassettes/entity_basic_text_json_search.yml
 - spec/vcr_cassettes/entity_basic_url_json_search.yml
+- spec/vcr_cassettes/image_tagging_basic_url_json_search.yml
 - spec/vcr_cassettes/keyword_basic_html_json_search.yml
 - spec/vcr_cassettes/keyword_basic_text_json_search.yml
 - spec/vcr_cassettes/keyword_basic_url_json_search.yml