openamplify 0.2.0 → 0.2.1

data/History

@@ -1,4 +1,6 @@
-0.2.0 - June 11, 2010
+0.2.1 - Jun 13, 2010
+      * added exceptions
+0.2.0 - Jun 11, 2010
       * added helpers to topic results
       * added post method
 0.1.1 - improved the notes

data/Rakefile

@@ -10,7 +10,11 @@ begin
     gem.email       = "rubyoncloud@gmail.com"
     gem.homepage    = "http://github.com/gregmoreno/openamplify"
     gem.authors     = ["Greg Moreno"]
+
     gem.add_dependency "json", "~>1.2"
+
+    gem.add_development_dependency "shoulda", "~> 2.11"  
+
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -21,9 +25,13 @@ end
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
+# Note to run a single test do:
+# ruby -Ilib test/test_foo.rb
+
 
 begin
   require 'rcov/rcovtask'

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
+:patch: 1
 :major: 0
-:minor: 2
 :build: 
-:patch: 0
+:minor: 2

data/lib/openamplify.rb

@@ -7,16 +7,17 @@ module OpenAmplify
 
   class Client
     def initialize(options={})
-      @options = { :base_url => API_URL, :method => :get }
+      @options = { :api_url => API_URL, :method => :get }
       @options.merge!(OpenAmplify.symbolize_keys(options))
     end
 
     def analyze_text(text)
-      Response.new(:base_url => @options[:base_url], :query => query.merge(:inputText => text), 
+      validate
+      Response.new(:api_url => @options[:api_url], :query => query.merge(:inputText => text), 
                    :method => @options[:method])
     end
     
-    %w(api_key analysis base_url method).each do |attr|
+    %w(api_key analysis api_url method).each do |attr|
       class_eval <<-EOS
         def #{attr}
           @options[:#{attr}]
@@ -47,7 +48,11 @@ module OpenAmplify
     end
 
     def request_url
-      @request_url ||= compose_url(@options[:base_url], @options[:query]) 
+      @request_url ||= compose_url(@options[:api_url], @options[:query]) 
+    end
+
+    def reload
+      response
     end
     
     def each
@@ -96,6 +101,7 @@ module OpenAmplify
     end
 
     private
+
     def compose_url(path, params)
       path + '?' + URI.escape(params.collect{ |k, v| "#{k}=#{v}" }.join('&'))
     end
@@ -117,21 +123,26 @@ module OpenAmplify
     end
 
     def fetch_as_format(format)
-      fetch(@options[:base_url], @options[:query].merge(:outputFormat => format), @options[:method])
+      fetch(@options[:api_url], @options[:query].merge(:outputFormat => format), @options[:method])
     end
 
     def fetch(path, params, method)
+      raise OpenAmplify::NotSupported unless [:get, :post].include?(method.to_sym)
       self.send(method, path, params)
     end
 
     def get(path, params)
-      url = compose_url(path, params)
-      Net::HTTP.get_response(URI.parse(url)).body
+      uri      = URI.parse(compose_url(path, params))
+      response = Net::HTTP.get_response(uri)
+      self.class.validate(response) 
+      response.body
     end
 
     def post(path, params)
-      uri = URI::parse(path)
-      Net::HTTP.post_form(uri, params).body
+      uri      = URI::parse(path)
+      response = Net::HTTP.post_form(uri, params)
+      self.class.validate(response)
+      response.body
     end
 
   end # OpenAmplify::Response
@@ -146,3 +157,5 @@ module OpenAmplify
   end
 
 end # module OpenAmplify
+
+require 'openamplify/validations'

data/lib/openamplify/validations.rb

@@ -0,0 +1,45 @@
+module OpenAmplify
+
+  class Client
+
+    private
+
+    def validate
+      raise ArgumentError, "missing api key" if self.api_key.blank?
+      raise ArgumentError, "missing api url" if self.api_url.blank?
+    end
+  end
+
+
+  class NotAcceptable < StandardError; end
+  class NotSupported  < StandardError; end
+  class Forbidden     < StandardError; end
+
+
+  class Response
+    def self.validate(response)
+      case response.code.to_i
+        when 403
+          raise Forbidden, "(#{response.code}: #{response.message}) #{response.body}"
+        when 405
+          raise NotSupported, "(#{response.code}: #{response.message}) #{response.body}"
+        when 406
+          raise NotAcceptable, "(#{response.code}: #{response.message}) #{response.body}" 
+      end
+    end
+  end
+
+end
+
+class String
+  def blank?
+    nil? || empty? || strip.empty? 
+  end
+end
+
+class NilClass
+  def blank?
+    nil?
+  end
+end
+

data/openamplify.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{openamplify}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Greg Moreno"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-06-13}
   s.description = %q{The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content.}
   s.email = %q{rubyoncloud@gmail.com}
   s.extra_rdoc_files = [
@@ -24,13 +24,18 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION.yml",
      "lib/openamplify.rb",
-     "openamplify.gemspec"
+     "lib/openamplify/validations.rb",
+     "openamplify.gemspec",
+     "test/test_openamplify.rb"
   ]
   s.homepage = %q{http://github.com/gregmoreno/openamplify}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Wrapper for the OpenAmplify API}
+  s.test_files = [
+    "test/test_openamplify.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -38,11 +43,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, ["~> 1.2"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11"])
     else
       s.add_dependency(%q<json>, ["~> 1.2"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11"])
     end
   else
     s.add_dependency(%q<json>, ["~> 1.2"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11"])
   end
 end
 

data/test/test_openamplify.rb

@@ -0,0 +1,91 @@
+require 'test/unit'
+require 'shoulda'
+require 'openamplify'
+
+class OpenAmplifyTest < Test::Unit::TestCase
+
+  context "Client instance" do
+
+    should "raise an error if api key is missing" do
+      assert_raises ArgumentError do 
+        client = OpenAmplify::Client.new
+        client.analyze_text("sample")
+      end
+    end
+
+    should "not raise an error if api key is present" do
+      assert_nothing_raised do
+        client.analyze_text("sample")
+      end
+    end
+
+    should "raise an error if api key is not authorized" do
+      assert_raises OpenAmplify::Forbidden do
+        client = OpenAmplify::Client.new(:api_key => 'SOME_KEY')
+        client.analyze_text("sample").reload
+      end
+    end
+
+    should "raise an error if api_url is missing" do
+      assert_raises ArgumentError do
+        client.api_url = ''
+        client.analyze_text('sample')
+      end
+    end
+
+    should "not raise an error if api_url is present" do
+      assert_nothing_raised do
+        client.analyze_text('sample')
+      end
+    end
+
+  end # context "Client instance"
+  
+  context "Response" do
+  
+    should "raise an error if empty text" do
+      assert_raises OpenAmplify::NotAcceptable do
+        client.analyze_text('').reload
+      end
+    end
+
+    should "not raise an error if there is input text" do
+      assert_nothing_raised do
+        client.analyze_text('sample').reload
+      end
+    end
+
+    should "raise error if analyis is not supported" do
+      assert_raises OpenAmplify::NotSupported do
+        client.analysis = 'not supported'
+        client.analyze_text('sample').reload
+      end
+    end
+
+  end  # Response
+
+  context "Request methods" do
+    
+    should "raise an error if not supported" do
+      assert_raises OpenAmplify::NotSupported do
+        client.method = :delete
+        client.analyze_text('sample').reload
+      end
+    end
+
+    [:get, :post].each do |method|
+      should "not raise error for #{method}" do
+        assert_nothing_raised do
+          client.method = method
+          client.analyze_text('sample').reload
+        end
+      end
+    end
+
+  end # Request methods
+
+  def client
+    @client ||= OpenAmplify::Client.new(:api_key => ENV['OPEN_AMPLIFY_KEY'])
+  end
+
+end # OpenAmplifyTest

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: openamplify
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Greg Moreno
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -07:00
+date: 2010-06-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,21 @@ dependencies:
         version: "1.2"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  version_requirements: *id002
 description: The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content.
 email: rubyoncloud@gmail.com
 executables: []
@@ -50,7 +65,9 @@ files:
 - Rakefile
 - VERSION.yml
 - lib/openamplify.rb
+- lib/openamplify/validations.rb
 - openamplify.gemspec
+- test/test_openamplify.rb
 has_rdoc: true
 homepage: http://github.com/gregmoreno/openamplify
 licenses: []
@@ -85,5 +102,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Wrapper for the OpenAmplify API
-test_files: []
-
+test_files: 
+- test/test_openamplify.rb