panlex_client 0.2.0 → 0.3.0

data/README.md

@@ -1,21 +1,22 @@
 # panlex\_client 
-Simple Ruby client for the [public API](http://dev.panlex.org/api/) of the [Panlex Database](http://panlex.org).
+
+Simple Ruby client for the [public API](http://dev.panlex.org/api/) of the [PanLex Database](http://panlex.org). It uses [rest-client](https://github.com/adamwiggins/rest-client) gem.
 
 ## Usage
 
-Right now, there is just a `PanlexClient` module with only one `query` method with two arguments: the URL parameter and the request body. It returns PanLex API response parsed to a Hash.
+Right now, there is just a `PanlexClient` module with only one `query` method wich takes two arguments: the URL parameter and the request body. It returns PanLex API response parsed to a Hash or raises an exception with the response in it.
 
 ```ruby
 require 'panlex_client'
 
-response = PanlexClient.query 'lv', { :indent => true, :limit => 2 }
-
-if response['status'] == 'OK' then
+begin
+  response = PanlexClient.query 'lv', { :indent => true, :limit => 2 }
   response['result'].each do |language|
-     puts language['tt']
+    puts language['tt']
   end
+rescue RestClient::ExceptionWithResponse => e
+  puts JSON.parse(e.response)['message']
 end
-
 ```
 
 ## Relase Policy

data/lib/panlex_client/panlex_client.rb

@@ -8,8 +8,13 @@ module PanlexClient
    # @param param [String] {http://dev.panlex.org/api/#urlparam PanLex API URL parameter}
    # @param body [#to_json] The request body which includes the query parameters. Look at the {http://dev.panlex.org/api/#globalparam global optional parameter} and the specifics for each URL parameter
    # @return [Hash] {http://dev.panlex.org/api/#globalparam PanLex API response} 
+   # @raise [RestClient::ExceptionWithResponse] if there is an error in the response. You can use e.response to access the PanLex API error response
    def self.query(param, body)
-      response = RestClient.post API_URL+param, body.to_json, { 'content-type' => :json, :accept => :json, 'accept-encoding' => 'gzip' }
-      JSON.parse(response)
+     begin
+       response = RestClient.post API_URL+param, body.to_json, { 'content-type' => :json, :accept => :json, 'accept-encoding' => 'gzip' }
+       JSON.parse(response)
+     rescue RestClient::ExceptionWithResponse => e
+       raise e
+     end
    end
 end

data/panlex_client.spec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
    s.name = 'panlex_client'
-   s.version = '0.2.0'
+   s.version = '0.3.0'
    s.summary = 'Client for the PanLex database public API'
    s.description = 'https://github.com/laMarciana/panlex_client/'
    s.license = 'GPL3'
@@ -12,4 +12,6 @@ Gem::Specification.new do |s|
    s.add_runtime_dependency "rest-client", "~>1.6"
    s.add_runtime_dependency "yard", "~>0.8"
    s.add_runtime_dependency "redcarpet", "~>2.2"
+
+   s.add_development_dependency "rspec", "~>2.13"
 end

data/spec/lib/panlex_client/panlex_client_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper' 
+
+describe PanlexClient do
+  describe "::query" do
+    context "when the request is successfully" do
+      it "should return PanLex response parsed in a Hash" do
+        response = PanlexClient.query 'lv', { limit: 1 }
+        response.should be_an_instance_of Hash
+      end
+    end
+
+    context "when the request is not successfully" do
+      it "should raise an exception with the response" do
+        expect { PanlexClient.query 'foo', {} }.to raise_error RestClient::ExceptionWithResponse
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/panlex_client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panlex_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
 description: https://github.com/laMarciana/panlex_client/
 email: marc@lamarciana.com
 executables: []
@@ -72,6 +88,8 @@ files:
 - lib/panlex_client.rb
 - lib/panlex_client/panlex_client.rb
 - panlex_client.spec
+- spec/lib/panlex_client/panlex_client_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/laMarciana/panlex_client/
 licenses:
 - GPL3