ruby-carrot 0.6.5 → 0.7.1

data/lib/ruby-carrot.rb

@@ -1,3 +1,9 @@
+# Author::    Jorge Vargas  (mailto:jorge.vargas@voicebunny.com)
+# Copyright:: Copyright (c) 2008 Torrenegra IP, LLC.
+# License::   Distributed under Creative Commons CC-BY license http://creativecommons.org/licenses/by/3.0/
+
+# This module hace the class that handle the connection
+# to the VoiceBunny API
 
 module RubyCarrot
   class VBCarrot
@@ -10,6 +16,7 @@ module RubyCarrot
     @api_user = nil
     @api_key = nil
 
+    # Initializes the carrot and save the account information on class variables
     def initialize(user, id, key)
       @api_id = id
       @api_user = user
@@ -18,6 +25,7 @@ module RubyCarrot
       setup
     end
 
+    # Setup the connection to the API using Faraday, and saves the connection object in a class variable
     def setup
         @conn = Faraday.new(:url =>("https://"+ @api_id.to_s+":"+@api_key +"@"+API_BASE_URL),:ssl => {:verify => false}) do |builder|
           builder.use Faraday::Request::Multipart
@@ -27,72 +35,139 @@ module RubyCarrot
         end
     end
 
+    # Returns the balance of the user initialized
     def balance
       resp = @conn.get 'balance.json'
       resp.body
     end
 
+    # Returns the projects created by the user initialized
     def all_projects
       resp = @conn.get 'projects.json'
       resp.body
     end
 
+    # Return the project with the specified ID
     def get_project(id)
       resp = @conn.get 'projects/'+id.to_s+'.json'
       resp.body
     end
 
+    # Create a project given a hashtable with the project information
     def create_project(project)
-      resp = @conn.post 'projects/add.json', {
+      resp = @conn.post 'projects/addSpeedy.json', {
           title: project[:title],
           script: project[:script],
-          rewardAmount: project[:rewardAmount],
+          price: project[:price],
           genderAndAge: project[:genderAndAge],
           language: project[:language],
           lifetime: project[:lifetime],
           ping: project[:ping],
           test: project[:test],
-          rewardCurrency: project[:rewardCurrency],
-          specialInstructions: project[:specialInstructions]
+          currency: project[:currency],
+          remarks: project[:remarks],
+          timedRecording: project[:timedRecording]
         }
 
       resp.body
     end
 
+    # Create a booking project for a certain user
+    def create_booking_project(project)
+      resp = @conn.post 'projects/addBooking.json', {
+          title: project[:title],
+          script: project[:script],
+          talentID: project[:talentID],
+          genderAndAge: project[:genderAndAge],
+          language: project[:language],
+          lifetime: project[:lifetime],
+          ping: project[:ping],
+          test: project[:test],
+          currency: project[:currency],
+          remarks: project[:remarks],
+          timedRecording: project[:timedRecording]
+        }
+
+      resp.body
+    end
+
+    # Dispose the project with the specified ID
     def force_dispose(id)
       resp = @conn.get 'projects/forceDispose/'+id.to_s+'.json'
       resp.body
     end
 
-    def quote(text, contest=0, maxContestEntries=3)
-      resp = @conn.post 'projects/quote.json', {
-          script: text,
-          contest: contest,
-          maxContestEntries: maxContestEntries
-      }
+    # Returns the suggested amount of money, of a a project with the given script
+    def quote(params)
+      data = Hash.new
+      data[:language] = params[:language]
+      data[:fulfilmentType] = params[:fulfilmentType]
+      data[:maxEntries] = params[:maxEntries]
+      data[:talentID] = params[:talentID]
+      if params.has_key?('numberOfCharacters')
+        data[:numberOfCharacters] = params[:numberOfCharacters]
+      elsif params.has_key?('numberOfWords')
+        data[:numberOfWords] = params[:numberOfWords]
+      else
+        data[:script] = params[:script]
+      end
+      resp = @conn.post 'projects/quote.json', data
       resp.body
     end
 
+    # Returns the read with the specified ID
     def get_read(id)
       resp = @conn.get 'reads/'+id.to_s+'.json'
       resp.body
     end
 
+    # Approve the read with the specified ID
     def approve_read(id)
       resp = @conn.get 'reads/approve/'+id.to_s+'.json'
       resp.body
     end
 
+    # Reject the read with the specified ID
     def reject_read(id)
       resp = @conn.get 'reads/reject/'+id.to_s+'.json'
       resp.body
     end
 
+    # Quote how much a revision of a given read cost
+    def revision_quote(readId, params)
+      data = Hash.new
+      data[:voiceBunnyError] = params[:voiceBunnyError]
+      if params.has_key?('charactersAddedOrChanged')
+        data[:charactersAddedOrChanged] = params[:charactersAddedOrChanged]
+      else
+        data[:wordsAddedOrChanged] = params[:wordsAddedOrChanged]
+      end
+      resp = @conn.get 'reads/'+readId.to_s+'/revision/quote.json', data
+      resp.body
+    end
+
+    # Request a revision for a given read
+    def revision_add(readId, params)
+      data = Hash.new
+      data[:ping] = params[:ping]
+      data[:instructions] = params[:instructions]
+      data[:voiceBunnyError] = params[:voiceBunnyError]
+      if params.has_key?('charactersAddedOrChanged')
+        data[:charactersAddedOrChanged] = params[:charactersAddedOrChanged]
+      else
+        data[:wordsAddedOrChanged] = params[:wordsAddedOrChanged]
+      end
+      resp = @conn.get 'reads/'+readId.to_s+'/revision/add.json', data
+      resp.body
+    end
+
+    # Return a list of all the languages supported by the service
     def languages
       resp = @conn.get 'languages.json'
       resp.body
     end
 
+    # Return a list of all the gender and ages supported by the service
     def gender_ages
       resp = @conn.get 'genderAndAges.json'
       resp.body

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-carrot
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,33 +10,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &18496488 !ruby/object:Gem::Requirement
+  requirement: &3180312 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *18496488
+  version_requirements: *3180312
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &18489264 !ruby/object:Gem::Requirement
+  requirement: &3179196 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *18489264
+  version_requirements: *3179196
 - !ruby/object:Gem::Dependency
   name: test/unit
-  requirement: &18487572 !ruby/object:Gem::Requirement
+  requirement: &3178332 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,9 +44,9 @@ dependencies:
         version: 2.4.5
   type: :development
   prerelease: false
-  version_requirements: *18487572
+  version_requirements: *3178332
 description: VoiceBunny library for accessing API using Ruby.
-email: jorge.vargas@voicebunny.com
+email: api@voicebunny.com
 executables: []
 extensions: []
 extra_rdoc_files: []