iodruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59f5c08725693815e3dea872861326aa283defd2
-  data.tar.gz: 87f72a722a9ff5b182a0cae77d52c6ce433d51bf
+  metadata.gz: 706940c880b86e48f147a9b92e72213cbfd59869
+  data.tar.gz: 50561f394c4935b9b641af5909583ea01f21cf5f
 SHA512:
-  metadata.gz: 9e9b480e267116ae47bba410d8f5bfac5e835d1f9f51f6d3f1b345714a95833ac8f510492dd6dc69a7a30110524f8bdac5cf5e40ae7bc678a32a51cf7ffd569b
-  data.tar.gz: 80db91a0040c189eb9e87bdc786b8cc4bc4950a2b1434444e7647904bb0fa76804bacc4e648b267024f91c0e69e1d8bdd98c89e272c9aef7fe8ee3a72d55355a
+  metadata.gz: 27a1eba1d619cc3b6a24437e2837cc6e483ecf295f9688545915939b8a69055a81d07e11445b4ed33d555a5ef7ce2d04b42df3c4ca7c29563a3350ec68eb1ca5
+  data.tar.gz: e6ac74f31e0f4c0582d423c066f392129c865d5d97f242ab8286ada2ceb086c4a4d38516c726958b276dad45c8e52f47778835f7e7c1df83210dcb85de285467

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,4 +1,4 @@
-# Iodruby
+# iodruby
 
 Ruby Gem to help call IDOL OnDemand API.
  [http://idolondemand.com](http://idolondemand.com)
@@ -6,11 +6,17 @@ Ruby Gem to help call IDOL OnDemand API.
 
 ## Installation
 
-To install from this git repo use the specific_install gem.
+To install from rubygems.org.
+
+```
+gem install iodruby
+```
+
+To install the latest version from this github repo, use the specific_install gem.
 
 ```
 gem install specific_install
-gem specific_install http://github.com/lemoogle/iodruby
+gem specific_install https://github.com/HP-IDOL-OnDemand/iodruby
 ```
 
 
@@ -18,15 +24,19 @@ gem specific_install http://github.com/lemoogle/iodruby
 
 
 ### Importing
-
+When using rails and other frameworks with a gem file, include it in it.
+```ruby
+gem "iodruby"
 ```
+Or, require it directly in your app.
+```ruby
 require "iodruby"
 ```
 
 ###Initializing the client
 
-```
-client= IODClient.new("http://api.idolondemand.com",$apikey)
+```ruby
+client = IODClient.new("http://api.idolondemand.com", $apikey)
 ```
 
 All that is needed to initialize the client is an apikey and the url of the API.
@@ -35,33 +45,32 @@ All that is needed to initialize the client is an apikey and the url of the API.
 ###Sending requests
 
 ```ruby
-r=client.post('analyzesentiment',{:text=>'I like cats'})
+r = client.post('analyzesentiment', {:text=>'I like cats'})
 ```
 The client's *post* method takes the apipath that you're sending your request to as well as an object containing the parameters you want to send to the api. You do not need to send your apikey each time as the client will handle that automatically
 
 ###Posting files
-
 ```ruby
-r=client.post('ocrdocument',{:file=>File.new("/path/to/file", 'rb')})
+r = client.post('ocrdocument', {:file=>File.new("/path/to/file", 'rb')})
 ```
 Sending files is just as easy.
 
 ```ruby
-r=client.post('ocrdocument',{:mode=>'photo',:file=>File.new("/path/to/file", 'rb')})
-r=client.post('ocrdocument',{:mode=>'photo',:file=>File.new("/path/to/file", 'rb')})
+r = client.post('ocrdocument', {:mode=>'photo',:file=>File.new("/path/to/file", 'rb')})
+r = client.post('ocrdocument', {:mode=>'photo',:file=>File.new("/path/to/file", 'rb')})
 ```
 Any extra parameters should be added in the same way as regular calls, or in the data parameter.
 
 ###Parsing the output
 
 ```ruby
-myjson=r.json()
+myjson = r.json()
 ```
 
 The object returned is a response object from the python [requests library](http://docs.python-requests.org/en/latest/) and can easily be turned to json.
 
 ```ruby
-docs=myjson["documents"]
+docs = myjson["documents"]
 array.each {|doc| puts doc["title"] }
 ```
 
@@ -70,7 +79,7 @@ array.each {|doc| puts doc["title"] }
 **Creating an index**
 
 ```ruby
-index=client.createIndex("mytestindex",flavor="explorer")
+index = client.createIndex("mytestindex", flavor="explorer")
 ```
 
 An Index object can easily be created
@@ -84,7 +93,7 @@ The getIndex call will return an iodindex Index object but will not check for ex
 
 ```ruby
 indexes = client.listIndexes()
-indexes.fetch('myindex',client.createIndex('myindex'))
+indexes.fetch('myindex', client.createIndex('myindex'))
 ```
 
 Here we first check the list of our indexes and return a newly created index if the index does not already exist
@@ -100,8 +109,8 @@ An index can be deleted in two equivalent ways
 **Indexing documents**
 
 ```ruby
-doc1=IODDoc.new({title:"title1",reference:"doc1",content:"my content 1"})
-doc2=IODDoc.new({title:"title2",reference:"doc2",content:"my content 2"})
+doc1 = IODDoc.new({title: "title1", reference: "doc1", content: "my content 1"})
+doc2 = IODDoc.new({title: "title2", reference: "doc2", content: "my content 2"})
 ```
 Documents can be created as regular python objects
 
@@ -130,9 +139,9 @@ It makes it easy to batch together groups of documents.
 ####Indexing - Connectors
 
 ```ruby
-client= IODClient.new("http://api.idolondemand.com",$apikey)
-conn=IODConnector.new("mytestconnector",client)
-conn.create(type="web",config={ "url" => "http://www.idolondemand.com" })
+client = IODClient.new("http://api.idolondemand.com", $apikey)
+conn = IODConnector.new("mytestconnector", client)
+conn.create(type="web", config = { "url" => "http://www.idolondemand.com" })
 conn.delete()
 ```
 
@@ -142,7 +151,7 @@ conn.delete()
 For each call the Async parameter can be set to true to send an asynchronous request.
 
 ```ruby
-r=client.post('analyzesentiment',{:text=>'I like cats'},async=True)
+r = client.post('analyzesentiment', {:text => 'I like cats'}, async = true)
 print r.json()
 
 # will return status of call, queued or finished
@@ -154,14 +163,14 @@ puts r.result().json()
 Same thing for indexing.
 
 ```ruby
-r=index.commit(async=True)
+r = index.commit(async = true)
 ```
 
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/lemoogle/iodruby/fork )
+1. Fork it ( https://github.com/HP-IDOL-OnDemand/iodruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/iodruby.rb

@@ -138,8 +138,8 @@ class IODClient
     end
     Unirest.timeout(30)
     response=Unirest.post "#{@url}/#{@@version}/api/#{syncpath}/#{handler}/v#{@@apidefault}",
-                        headers:{ "Accept" => "application/json" },
-                        parameters:data
+                        headers:{ "Accept" => "application/json", "Content-Type" => "application/json"},
+                        parameters:data.to_json
     if response.code == 200
 
       if async

data/lib/iodruby/version.rb

@@ -1,3 +1,3 @@
 module Iodruby
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iodruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tyler Nappy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md