everwrite 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Everwrite
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,24 @@
+= Everwrite API
+
+Everwrite gem for API access.
+
+== Usage of Everwrite API
+ 
+* Get terms suggestion
+
+    Everwrite.api_key = "1234567890abcde"
+    @everapi = Everwrite.new :domain => 'yourdormain.com', :language =>'en'
+    @everapi.get_terms_suggestion "love"
+
+* Get keyword suggestion for texts
+
+    Everwrite.api_key = "1234567890abcde"
+    @everapi = Everwrite.new :domain => 'yourdormain.com', :language =>'en'
+    @everapi.get_keyword_suggestion_for_text title: "how to make hot chocolate", content: "chocholate is associated with ..."
+
+
+== Copyright
+
+Copyright (c) 2013 Everwrite. See LICENSE.txt for
+further details.
+

data/TODO

@@ -0,0 +1,5 @@
+- Generate docs (tomdoc)
+- Clean code
+- Write readme and examples
+- Put api_key in a config.properties file
+- Finally, publish gem

data/lib/everwrite.rb

@@ -0,0 +1,129 @@
+require 'net/http'
+require 'json'
+
+class Everwrite
+  VERSION = "0.0.1"
+
+  # Public: Set the API key.
+  #
+  # value - The String API key.
+  #
+  # Examples
+  #
+  #   EverApi.api_key = '123456'
+  #   # => '123456'
+  def self.api_key=(value)
+    @@api_key = value
+  end
+
+  # Public: Initialize an API instance.
+  #
+  # opts - The Hash of options (default {}):
+  #        :domain - The String domain.
+  def initialize(opts = {})
+    @domain   = opts[:domain]
+    @language = opts[:language]
+    @root_url = "http://api.everwrite.com/v1/"
+  end
+
+  # Public: Query the API about given words.
+  #
+  # query - The String query to lookup.
+  # page - Pagination index.
+  #
+  # Examples
+  #
+  #   EverAPI.get_terms_suggestion 'Ruby on Rails'
+  #   # => [{"name": "ruby on rails web framework", "score": 3.123123132, "everank": 3.3333, ...},...]
+  #
+  # Returns an Array of Hash objects with suggestion of terms.
+  def get_terms_suggestion(query, page = 1)
+    response = Net::HTTP.get assemble_url_terms_suggestion query, page
+    @results = JSON.parse response
+  end
+
+  # Public: Query the API about given title and content.
+  #
+  # title - The title of the text.
+  # content - The content of the text.
+  # page - Pagination index.
+  #
+  # Examples
+  #
+  #   EverAPI.get_keyword_suggestion_for_text title: 'Ruby on Rails', content: 'Ruby on Rails is an open-source web framework'
+  #   # => [{"name": "ruby on rails open-source", "score": 4.123123132, "everank": 4.3333, ...},...]
+  #
+  # Returns an Array of Hash objects with suggestion of terms for the text.
+  def get_keyword_suggestion_for_text(params = {}, page = 1)
+    title = params[:title]
+    content = params[:content]
+    url = URI.join @root_url, 'text/keywords/suggestions/'
+    data = assemble_post_data_to_keyword_suggestion title, content, page
+    response = Net::HTTP.post_form url, data
+    JSON.parse(response.body)
+  end
+
+  private
+
+  # Private: Assemble search URL for terms suggestion.
+  #
+  # query - The String query to lookup.
+  # page - Pagination index.
+  #
+  # Examples
+  #
+  #   EverAPI.assemble_url_terms_suggestion 'Ruby on Rails'
+  #   # => #<URI URL:http://api.everwrite.com/api/:v/keywords/suggestions?domain=domain.com&api_key=123456&q=Ruby%20on%20Rails>
+  #
+  # Returns the URI search URL.
+  def assemble_url_terms_suggestion(query, page)
+    url = URI.join @root_url, 'keywords/suggestions'
+    url.query = URI.encode_www_form domain: @domain, api_key: @@api_key, q: query, lang: @language, page: page
+    url
+  end
+
+  # Private: Assemble URL POST data URL for keyword suggestion.
+  #
+  # title - The title of the text.
+  # content - The content of the text.
+  # page - Pagination index.
+  #
+  # Returns the POST data.
+  def assemble_post_data_to_keyword_suggestion(title, content, page)
+    data = {"domain" => @domain, "api_key" => @@api_key,
+            "title" => title, "content" => content,
+            "lang" => @language, "page" => page}
+  end
+
+  # Private: Assemble search URL for keyword suggestion for a text.
+  #
+  # title - The title of the text.
+  # content - The content of the text.
+  # page - Pagination index.
+  #
+  # Examples
+  #
+  #   EverAPI.assemble_url_keyword_suggestion_for_text 'Ruby on Rails', 'Ruby on Rails is an open-source web framework'
+  #   # => #<URI URL:http://api.everwrite.com/:v/text/keywords/suggestions?domain=domain.com&api_key=123456&title=Ruby%20on%20Rails&content=Ruby%20on%20Rails%20is%20an%20open-source%20web%20framework>
+  #
+  # Returns the URI search URL.
+  def assemble_url_keyword_suggestion_for_text(title, content, page)
+    url = URI.join @root_url, 'text/keywords/suggestions'
+    url.query = URI.encode_www_form domain: @domain, api_key: @@api_key, title: title, content: content, lang: @language, page: page
+    url
+  end
+
+end
+
+# quick test
+if __FILE__ == $PROGRAM_NAME
+  Everwrite.api_key = "1234567890abcde"
+  @everapi = Everwrite.new :domain => 'yourdormain.com', :language =>'en'
+
+  result = @everapi.get_terms_suggestion "love"
+  p result
+
+  result = @everapi.get_keyword_suggestion_for_text title: "how to make hot chocolate", content: "chocolate is associated with ..."
+  p result
+end
+

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: everwrite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Arruda
+- Edmar Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: verwrite API gem
+email: edmar@everwrite.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+- TODO
+files:
+- lib/everwrite.rb
+- LICENSE.txt
+- README.rdoc
+- TODO
+homepage: http://github.com/everwrite/gem
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -486883497917090170
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Everwrite API
+test_files: []