panlex_client 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*gem
+*pid
+/doc
+.yardoc/
+.rdoc_options

data/.yardopts

@@ -0,0 +1,2 @@
+-m markdown
+- COPYING.txt

data/README.md

@@ -1,18 +1,22 @@
 # panlex\_client 
-Simply 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).
 
 ## 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. This is just a wrapper of [rest-client](https://github.com/rest-client/rest-client) `RestClient.post` method, so you can check there for more documentation.
+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.
 
-    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
-    end
+```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
+end
+```
 
 ## LICENSE
 

data/lib/panlex_client/panlex_client.rb

@@ -1,6 +1,15 @@
+# panlex_client namespace
 module PanlexClient
+   # PanLex public API URL
    API_URL = 'http://api.panlex.org/'
 
+   # Send a request to PanLex API.
+   #
+   # @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
    end

data/panlex_client.spec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+   s.name = 'panlex_client'
+   s.version = '0.1.1'
+   s.summary = 'Client for the PanLex database public API'
+   s.description = 'https://github.com/laMarciana/panlex_client/'
+   s.license = 'GPL3'
+   s.homepage = 'https://github.com/laMarciana/panlex_client/'
+   s.authors = ['Marc Busqué']
+   s.email = 'marc@lamarciana.com'
+   s.files = `git ls-files`.split("\n")
+
+   s.add_runtime_dependency "rest-client", "~>1.6"
+
+   s.add_development_dependency "yard", "~>0.8"
+   s.add_development_dependency "redcarpet", "~>2.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panlex_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -19,7 +19,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -27,17 +27,51 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: https://github.com/laMarciana/panlex_client/
 email: marc@lamarciana.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
-- COPYNG
+- .gitignore
+- .yardopts
+- COPYING.txt
 - README.md
 - lib/panlex_client.rb
 - lib/panlex_client/panlex_client.rb
+- panlex_client.spec
 homepage: https://github.com/laMarciana/panlex_client/
 licenses:
 - GPL3
@@ -64,3 +98,4 @@ signing_key:
 specification_version: 3
 summary: Client for the PanLex database public API
 test_files: []
+has_rdoc: