panlex_client 0.1.2 → 0.2.0

data/README.md

@@ -3,21 +3,25 @@ Simple Ruby client for the [public API](http://dev.panlex.org/api/) of the [Panl
 
 ## Usage
 
-Right now, there is just a `PanlexClient` module with only one `query` method which accepts three arguments: the URL parameter, the request body and an optional block to process the response and which accept three arguments: response, request and result.
+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.
 
 ```ruby
 require 'panlex_client'
 
-PanlexClient.query 'lv', { :indent => true, :limit => 2 } do |response, request, result|
-   response_json = JSON.parse(response)
-   if response_json['status'] == 'OK' then
-      response_json['result'].each do |language|
-         puts language.to_s
-      end
-   end
+response = PanlexClient.query 'lv', { :indent => true, :limit => 2 }
+
+if response['status'] == 'OK' then
+  response['result'].each do |language|
+     puts language['tt']
+  end
 end
+
 ```
 
+## Relase Policy
+
+panlex_client follows the principles of [semantic versioning](http://semver.org/). panlex_client is still in an 0.x.y version, so it is not considered stable and anything can change at any moment.
+
 ## LICENSE
 
 Copyright 2013 Marc Busqué - <marc@lamarciana.com>

data/lib/panlex_client/panlex_client.rb

@@ -3,14 +3,13 @@ module PanlexClient
    # PanLex public API URL
    API_URL = 'http://api.panlex.org/'
 
-   # Send a request to PanLex API.
+   # Send a request to PanLex API and return JSON.
    #
    # @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
-   # @yieldparam response [String] The response from PanLex, a string you can parse to JSON
-   # @yieldparam request [RestClient::Request]
-   # @yieldparam result [Net::HTTPOK] 
-   def self.query(param, body, &block)
-      RestClient.post API_URL+param, body.to_json, { :content_type => :json, :accept => :json }, &block
+   # @return [Hash] {http://dev.panlex.org/api/#globalparam PanLex API 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)
    end
 end

data/panlex_client.spec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
    s.name = 'panlex_client'
-   s.version = '0.1.2'
+   s.version = '0.2.0'
    s.summary = 'Client for the PanLex database public API'
    s.description = 'https://github.com/laMarciana/panlex_client/'
    s.license = 'GPL3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panlex_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client