one_sky 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+rdoc/*
+*.gem
+.bundle
+*.swp

data/CHANGELOG

@@ -0,0 +1,5 @@
+= Change log
+
+== 0.0.1 (03 Jan 2010)
+* Initial release.
+

data/CREDITS

@@ -0,0 +1,6 @@
+= Credits
+
+Junjun Olympia (@beljun), http://rubyredtomatoes.com
+
+* Initial code.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in one_sky.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    one_sky (0.0.1)
+      json (~> 1.4.6)
+      rest-client (~> 1.6.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    mime-types (1.16)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  json (~> 1.4.6)
+  one_sky!
+  rest-client (~> 1.6.1)
+  rspec (~> 2.2.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 {OneSky, Inc.}[link:http://www.oneskyapp.com]
+
+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,77 @@
+= OneSky: The Community-Powered Translation Service
+
+OneSky[link:http://www.oneskyapp.com] is a new service that lets developers reach a global audience by easily enabling them to translate their websites and applications to different languages through the help of the community.
+
+This gem is the basic interface to the RESTful API. It is used as the main building block for higher-level utilities and libraries such as the i18n-one_sky[link:http://rubygems.org/gems/i18n-one_sky] gem.
+
+= Installing
+
+Get from RubyGems.org by:
+
+  gem install one_sky
+
+= Usage
+
+Just the basic usage scenarios are shown here. See OneSky::Project for more available methods.
+
+== Initialization
+
+Provide the API key and secret which you can get from the web UI. Also provide the name of the project you created.
+
+  require 'one_sky'
+
+  client = OneSky::Project.new("my_api_key", "my_api_secret", "my_project")
+
+== Submit a phrase for translation
+
+Submit a string with no other parameters:
+
+  client.input("Hello World!")
+
+You can also provide other parameters:
+
+  client.input("Hello World!", :string_key => "my_string_key", :context => "my_context", :page => "my_page")
+
+== Get translated phrases
+
+So you've submitted your phrases and your translators/users or the general OneSky[link:http://www.oneskyapp.com] community have kindly provided translations for them. It's time now to download those.
+
+  translations = client.output
+
+  => {"Default"=>{"en-us"=>{"Hello World!"=>"Hello World!"}, "zh-cn"=>{"Hello World!"=>"\u4E16\u754C\u60A8\u597D\uFF01"}, "es-es"=>{"Hello World!"=>"Hola Mundo!"}}}
+
+Let's pretty print that a bit:
+
+  translations["Default"].map { |k,v| puts "#{k}: #{v['Hello World!']}" }
+
+  en-us: Hello World!
+  zh-cn: 世界您好！
+  es-es: Hola Mundo!
+
+== Provide a single sign-on (SSO) link for your translators
+
+OneSky[link:http://www.oneskyapp.com] is all about community-powered translations. You can mark your project as public and any OneSky[link:http://www.oneskyapp.com] member translator can help in translating your phrases. Or if you mark it as private, only those you give access to can do so. For instance, you'd like your own website's user base to help you out. You can take a user's unique ID and bind it to OneSky:
+
+  client.get_sso_link("myapp/users/123456")
+  => "http://rubyredtomatoes.oneskyapp.com/?time=1294020222&id=myapp/users/123456&data=3d56315499647c0419867283767aa270"
+
+That user can then use the above link to automatically sign in to OneSky[link:http://www.oneskyapp.com] and start translating for you.
+
+= Using with Rails
+
+See the i18n-one_sky[link:http://rubygems.org/gems/i18n-one_sky] gem for Rails and I18n integration.
+
+= History
+
+See CHANGELOG[link:CHANGELOG.html]
+
+= Credits
+
+See CREDITS[link:CREDITS.html]
+
+= License
+
+Copyright 2010-2011 {OneSky, Inc.}[link:http://www.oneskyapp.com/]
+
+Licensed under the {MIT License}[link:MIT-LICENSE.html].
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# = RDoc 
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'rdoc'
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'CHANGELOG', 'CREDITS', 'lib/**/*.rb')
+end
+

data/lib/one_sky/project.rb

@@ -0,0 +1,112 @@
+module OneSky
+  # This is the main class used to interact with the OneSky API and maps to a project on their web site.
+  class Project
+    attr_accessor :api_key, :api_secret, :name
+
+    # Provide the name of the project you created on the OneSky website. Also, the API key and secret shown there.
+    def initialize(api_key, api_secret, name)
+      raise ArgumentError, "api_key, api_secret, and name cannot be nil." unless [api_key, api_secret, name].all?
+      @api_key, @api_secret, @name = api_key, api_secret, name
+    end
+
+    # Returns details about the project.
+    def details
+      get("/details")["project"]
+    end
+
+    # Returns an array of available languages.
+    def languages
+      get("/languages")["languages"]
+    end
+
+    # Returns the SSO URL for the given unique_id
+    def get_sso_link(unique_id)
+      get("/sso/get-link", {:"unique-id" => unique_id})["url"]
+    end
+
+    # Submits a string for translation.
+    # Takes an optional hash of parameters, too:
+    # * :string_key
+    # * :context 
+    # * :page
+    def input(string, options = {})
+      options = {:string => string}.merge(options)
+      post("/string/input", hash_to_params(options))
+      true
+    end
+
+    # Submits a bulk translation request.
+    # Parameters:
+    # * hashes - An array of hashes with mandatory key :string and optional keys (:string_key, :context)
+    # * An optional hash with keys:
+    #   * :page
+    def input_bulk(hashes, options = {})
+      arrs = hashes.inject([[],[],[]]) do |o,e|
+        o[0] << e[:string]; o[1] << e[:string_key]; o[2] << e[:context]; o
+      end
+
+      post("/string/input-bulk", {:strings => arrs[0], :"string-keys" => arrs[1], :contexts => arrs[2]}.merge(options))
+      true
+    end
+
+    # Uploads a PO file for the given language.
+    # See #languages for a list of supported language codes.
+    # Takes an optional hash of parameters:
+    # * :page
+    def input_po(language, file_name, options = {})
+      response = post("/string/input-po", {:language => language, :file => File.new(file_name, "rb")}.merge(options), {}) 
+      true
+    end
+
+    alias_method :upload_po, :input_po
+
+    # Gets the strings with available translations.
+    # Takes these optional parameters, too:
+    # * :language
+    # * :page
+    # * :md5
+    #--
+    # ToDo: Probably need to expose MD5 response values for caching implementations.
+    #++
+    def output(options = {})
+      get("/string/output", hash_to_params(options))["translation"]
+    end
+
+    # Downloads the compiled MO file for the given language and saves it as file_name.
+    # See #languages for a list of supported language codes.
+    # Takes an optional hash of parameters:
+    # * :page
+    def output_mo(language, file_name, options = {})
+      response = get("/string/output-mo", {:language => language}.merge(options)) 
+      File.open(file_name, "w") { |f| f.print response }
+      true
+    end
+
+    alias_method :download_mo, :output_mo
+
+    protected
+
+    def hash_to_params(hash)
+      hash.inject({}) { |o, (k,v)| o[k.to_s.gsub("_", "-").to_sym] = v; o }
+    end
+  
+    def get(path, params = {}, options = {:content_type => "text/plain; charset=UTF-8"})
+      params = {:"api-key" => @api_key, :"api-secret" => @api_secret, :"project" => @name}.merge(params)
+      parse_response(RestClient.get([API_ROOT_URL, path].join, {:params => params}.merge(options)))
+    end
+
+    def post(path, params = {}, options = {:content_type => "text/plain; charset=UTF-8"})
+      params = {:"api-key" => @api_key, :"api-secret" => @api_secret, :"project" => @name}.merge(params)
+      parse_response(RestClient.post([API_ROOT_URL, path].join, params.merge(options)))
+    end
+
+    def parse_response(response)
+      raise ApiHttpResponseError, "HTTP response status code: #{response.code.inspect}." unless response.code.eql?(200)
+      # Do not post-process response if it isn't JSON. (ie. Binary file returned from /output_mo.)
+      return response.body unless response.headers[:content_type] =~ /json/
+      response_hash = JSON.parse(response)
+      raise ApiError, response.body if response_hash.has_key?("response") and response_hash["response"] != "ok"
+      response_hash
+    end
+  end
+end

data/lib/one_sky/version.rb

@@ -0,0 +1,3 @@
+module OneSky
+  VERSION = "0.0.1"
+end

data/lib/one_sky.rb

@@ -0,0 +1,10 @@
+require 'json'
+require 'rest_client'
+
+module OneSky
+  API_ROOT_URL = "https://api.oneskyapp.com/1"
+
+  autoload :Project, 'one_sky/project'
+
+  %w[ApiHttpResponseError ApiError].each { |e| const_set(e, Class.new(StandardError)) }
+end

data/one_sky.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "one_sky/version"
+
+Gem::Specification.new do |s|
+  s.name        = "one_sky"
+  s.version     = OneSky::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Junjun Olympia"]
+  s.email       = ["romeo.olympia@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/one_sky"
+  s.summary     = %q{Ruby interface to the OneSky REST API}
+  s.description = %q{OneSky is a community-powered translation service for web and mobile apps. This gem is the core interface to the REST API and is used by other specialty gems such the OneSky extension for I18n, i18n-one_sky.}
+
+  s.rubyforge_project = "one_sky"
+
+  s.add_dependency "json", "~> 1.4.6"
+  s.add_dependency "rest-client", "~> 1.6.1"
+
+  s.add_development_dependency "rspec", "~> 2.2.0"
+  s.add_development_dependency "bundler", "~> 1.0.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/data/en-us.po

@@ -0,0 +1,21 @@
+msgid "This is the first line in the PO file."
+msgstr ""
+
+msgid "This is the second line in the PO file."
+msgstr ""
+
+msgid "And this is the last line in the PO file."
+msgstr ""
+
+msgid ""
+"Project-Id-Version: rubysdkspec\n"
+"POT-Creation-Date: 2010-12-16 19:29+0800\n"
+"PO-Revision-Date: 2010-12-16 19:32+0800\n"
+"Last-Translator: Junjun Olympia <romeo.olympia@gmail.com>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Poedit-KeywordsList: _;gettext;gettext_noop\n"
+"X-Poedit-Basepath: .\n"
+

data/spec/helpers.rb

@@ -0,0 +1,11 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'one_sky'
+
+module OneSkySpecHelpers
+  def create_project
+    raise "Please set environment variables: ONESKY_API_KEY, ONESKY_API_SECRET and ONESKY_SPEC_PROJ (default: rubysdkspec) before running spec." unless [ENV["ONESKY_API_KEY"], ENV["ONESKY_API_SECRET"]].all?
+    OneSky::Project.new(ENV["ONESKY_API_KEY"], ENV["ONESKY_API_SECRET"], ENV["ONESKY_SPEC_PROJ"] || "rubysdkspec")
+  end  
+end

data/spec/input_spec.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+require 'helpers'
+
+describe "Project" do
+  include OneSkySpecHelpers
+
+  before do
+    @project = create_project
+  end
+
+  describe "#input" do
+    # We use the spec description as the string sent to OneSky for translation.
+    # ToDo: Make this DRY.
+    it "returns true for a normal translate request." do
+      @project.input("input returns true for a normal translate request.").should be_true
+    end
+
+    it "returns true when non-latin characters are passed (こんにちは世界)." do
+      @project.input("input returns true when non-latin characters are passed (こんにちは世界).").should be_true
+    end
+
+    it "returns true when optional parameters are passed." do
+      @project.input("input returns true when optional parameters are passed.", 
+        :string_key => "string key", :string_context => "string context", :page => "page").should be_true
+    end
+  end
+
+  describe "#input_bulk" do
+    it "returns true for a normal translate request." do
+      input = []
+      input << {:string => "input_bulk returns true for a normal translate request (A).", :string_key => "input_bulk.key.1.a", :context => "input_bulk.context.1.a"}
+      input << {:string => "input_bulk returns true for a normal translate request (B).", :string_key => "input_bulk.key.1.b", :context => "input_bulk.context.1.b"}
+      input << {:string => "input_bulk returns true for a normal translate request (C)." }
+
+      @project.input_bulk(input).should be_true
+    end
+
+    it "returns true when non-latin characters are passed (こんにちは世界)." do
+      input = []
+      input << {:string => "input_bulk returns true when non-latin characters are passed (こんにちは世界) (A).", :string_key => "input_bulk.key.2.a", :context => "input_bulk.context.2.a"}
+      input << {:string => "input_bulk returns true when non-latin characters are passed (こんにちは世界) (B).", :string_key => "input_bulk.key.2.b", :context => "input_bulk.context.2.b"}
+      input << {:string => "input_bulk returns true when non-latin characters are passed (こんにちは世界) (C)." }
+
+      @project.input_bulk(input).should be_true
+    end
+
+    it "returns true when optional parameters are passed." do
+      input = []
+      input << {:string => "input_bulk returns true when optional parameters are passed (A).", :string_key => "input_bulk.key.3.a", :context => "input_bulk.context.3.a"}
+      input << {:string => "input_bulk returns true when optional parameters are passed (B).", :string_key => "input_bulk.key.3.b", :context => "input_bulk.context.3.b"}
+      input << {:string => "input_bulk returns true when optional parameters are passed (C)." }
+
+      @project.input_bulk(input, {:page => "input_bulk.page.3"}).should be_true
+    end
+  end
+
+  describe "#input_po" do
+    it "returns true after uploading a file." do
+      file_name = "#{File.dirname(__FILE__)}/data/en-us.po"
+      @project.input_po("en-us", file_name).should be_true
+    end
+  end
+end
+

data/spec/output_spec.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+require 'helpers'
+
+describe "Project" do
+  include OneSkySpecHelpers
+
+  before do
+    @project = create_project
+  end
+
+  describe "#output" do
+    it "returns a hash with a parent key called 'Default'" do
+      @project.output.has_key?("Default").should be_true
+    end
+
+    it "returns a hash with a parent key called 'Default' when optional parameters are passed." do
+      @project.output({:context => "Default"}).has_key?("Default").should be_true
+    end
+  end
+
+  describe "#output_mo" do
+    it "creates a file." do
+      file_name = "#{File.dirname(__FILE__)}/data/output.mo"
+      @project.output_mo("en-us", file_name)
+      File.exists?(file_name).should be_true
+      File.delete(file_name)
+    end
+
+    it "raises an error if an invalid language code is supplied." do
+      file_name = "#{File.dirname(__FILE__)}/data/output.2.mo"
+      lambda { @project.output_mo("en-xx", file_name) }.should raise_error
+    end
+  end
+end
+

data/spec/project_spec.rb

@@ -0,0 +1,40 @@
+require 'helpers'
+
+describe "Project" do
+  include OneSkySpecHelpers
+
+  it "raises an error when initialization values are nil." do
+    lambda { @project = OneSky::Project.new(nil, nil, nil) }.should raise_error ArgumentError
+  end
+end
+
+describe "Project" do
+  include OneSkySpecHelpers
+
+  before do
+    @project = create_project
+  end
+
+  it "raises an error when incorrect API credentials are passed." do
+    @project.api_secret = "wrong secret"
+    lambda { @project.details }.should raise_error OneSky::ApiError
+  end
+
+  describe "#details" do
+    it "returns project name among other things." do
+      @project.details["name"].should == @project.name
+    end
+  end
+
+  describe "#languages" do
+    it "returns an array." do
+      @project.languages.should be_an(Array)
+    end
+  end
+
+  describe "#get_sso_link" do
+    it "returns a URL string." do
+      @project.get_sso_link("rspec_process").should match /^http.*$/
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: one_sky
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Junjun Olympia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id004
+description: OneSky is a community-powered translation service for web and mobile apps. This gem is the core interface to the REST API and is used by other specialty gems such the OneSky extension for I18n, i18n-one_sky.
+email: 
+- romeo.olympia@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- CREDITS
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/one_sky.rb
+- lib/one_sky/project.rb
+- lib/one_sky/version.rb
+- one_sky.gemspec
+- spec/data/en-us.po
+- spec/helpers.rb
+- spec/input_spec.rb
+- spec/output_spec.rb
+- spec/project_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/one_sky
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: one_sky
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the OneSky REST API
+test_files: 
+- spec/data/en-us.po
+- spec/helpers.rb
+- spec/input_spec.rb
+- spec/output_spec.rb
+- spec/project_spec.rb