wordstream_client 0.0.3 → 0.0.4

data/lib/wordstream_client/config.rb

@@ -6,8 +6,11 @@ module WordstreamClient
       attr_accessor :username, :password, :session_id
     end
 
-    def self.instantiate # :nodoc:
-      new( username: username, password: password, session_id: session_id )
+    # Instantiate new instance
+    # @private
+
+    def self.instantiate
+      new( :username => username, :password => password, :session_id => session_id )
     end
 
     def self.client
@@ -33,7 +36,6 @@ module WordstreamClient
     end
 
     def session_id=(new_session)
-      # return false if new_session.to_s.empty?
       instance_variable_set "@session_id", new_session
       self.class.session_id = new_session
     end

data/lib/wordstream_client/exceptions.rb

@@ -4,7 +4,10 @@ module WordstreamClient
 
   class AuthError < WordstreamClientError
 
-    def initialize(method, message) # :nodoc:
+    # Initialize new AuthError
+    # @private
+
+    def initialize(method, message)
       super "WordstreamClient::Auth.#{method} - #{message}"
     end
 
@@ -12,6 +15,9 @@ module WordstreamClient
 
   class KeywordToolError < WordstreamClientError
 
+    # Initialize new KeywordToolError
+    # @private
+
     def initialize(method, message) # :nodoc:
       super "WordstreamClient::KeywordTool.#{method} - #{message}"
     end

data/lib/wordstream_client/keyword_tool.rb

@@ -4,6 +4,23 @@ module WordstreamClient
 
     attr_accessor :keywords
 
+    ##
+    # == Description
+    #
+    # Initializing a KeywordTool object for the keywordtool API calls.
+    # It is more convenient to set the username and password for Wordstream::Config
+    # and use KeywordTool class methods for API calls.
+    #
+    # == Params
+    #
+    # [config]      <b>Required</b> - 
+    #               WordstreamClient::Config object with valid username and passowrd
+    # [keywords]    <em>Optional</em> - 
+    #               Defaults to an empty array. Can be an array of keywords or a string of
+    #               keywords separated by newline "\n"
+    #
+    # @return       [KeywordTool] With keywords instance variable set.
+
     def initialize(config, keywords = [])
       @config   = config
       @keywords = keywords.is_a?(Array) ? keywords.join("\n") : keywords.to_s
@@ -13,15 +30,39 @@ module WordstreamClient
       @keywords = @keywords[0..3949]
     end
 
+    ##
+    # == Description
+    #
+    # get_keyword_volumes Wordstream API call. Takes list of keywords and returns
+    # an array of arrays of keywords and their volumes.
+    #
+    # == Params
+    #
+    # [keywords]    <b>Required</b> - 
+    #               Array of keywords or string of keywords separated by newline "\n"
+    # [block_adult] <em>Optional</em> - 
+    #               Defaults to 'false'. Set to 'true' if you want to block adult results.
+    #
+    # @return       [Array] Array of arrays of keywords and their volumes.
+    # @raise        [KeywordToolError] If error is returned in response body from Wordstream.
+    # @raise        [KeywordToolError] If bad JSON response from Wordstream.
+
     def self.get_volumes(keywords, block_adult = 'false')
       Config.client.keyword_tool(keywords).get_volumes(block_adult)
     end
 
+    ##
+    # == Description
+    #
+    # get_keyword_volumes Wordstream API call. Takes list of keywords and returns
+    # an array of arrays of keywords and their volumes. See class method {WordstreamClient::KeywordTool.get_volumes}.
+    #
+
     def get_volumes(block_adult = 'false')
       path         = '/keywordtool/get_keyword_volumes'
       url_keywords = URI.encode( @keywords, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") )
       query        = "?session_id=#{@config.session_id}&keywords=#{url_keywords}&block_adult=#{block_adult}"
-      resp         = RestClient.get( @config.default_host + path + query )
+      resp         = RestClient.post( @config.default_host + path + query, {} )
       data         = JSON.parse resp.body
 
       raise KeywordToolError.new('get_volumes', data['detail']) if data['code'].match(/error/i)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordstream_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wraps Wordstream API calls in a gem.
 email: ''
 executables: []