one_sky 1.0.0 → 2.0.0

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile.lock

@@ -1,33 +1,33 @@
 PATH
   remote: .
   specs:
-    one_sky (0.0.1)
-      json (~> 1.4.6)
-      rest-client (~> 1.6.1)
+    one_sky (2.0.0)
+      json (>= 1.4.0)
+      rest-client (>= 1.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    json (1.4.6)
-    mime-types (1.16)
-    rest-client (1.6.1)
+    diff-lcs (1.1.3)
+    json (1.6.3)
+    mime-types (1.17.2)
+    rest-client (1.6.7)
       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)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.2.0)
+    rspec-mocks (2.7.0)
+    time_freeze (0.1.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  json (~> 1.4.6)
+  bundler (>= 1.0.0)
   one_sky!
-  rest-client (~> 1.6.1)
   rspec (~> 2.2.0)
+  time_freeze

data/README.rdoc

@@ -20,23 +20,67 @@ Provide the API key and secret which you can get from the web UI. Also provide t
 
   require 'one_sky'
 
-  client = OneSky::Project.new("my_api_key", "my_api_secret", "my_project")
+  client = OneSky::Client.new("my_api_key", "my_api_secret")
+  
+== Project
+
+Load a specific project by name.
+
+  project = client.project("my-project-name")
+
+Get the details of the project.
+
+  project.details
+  
+See what platforms are available.
+
+  project.platforms
+  
+== Platform
+
+Load a specific platform by id.
+
+  platform = project.platform(123)
+  
+Get the details of the platform.
+
+  platform.details
+  
+See what locales are assigned.
+
+  platform.locales
+  
+== Translation
+
+Get the translation proxy for a platform
+
+  translation = platform.translation
 
 == Submit a phrase for translation
 
-Submit a string with no other parameters:
+Submit a single string:
+
+  translation.input_string("Hello World!")
+
+Submit a string with a specified key, context, and page:
+
+  translation.input_string(:string => "Hello World!", :string_key => "hello_world", :context => "my_context", :page => "my_page")
 
-  client.input("Hello World!")
+Submit many strings at once:
 
-You can also provide other parameters:
+  translation.input_strings(["Hello World!", "Goodbye Moon"])
+  
+== Provide a translation
 
-  client.input("Hello World!", :string_key => "my_string_key", :context => "my_context", :page => "my_page")
+Submit a translation for a given key, in a given locale.
 
+  translation.translate("hello_world", "zh_CN", "世界你好")
+  
 == 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
+  translations = translation.output
 
   => {"Default"=>{"en-us"=>{"Hello World!"=>"Hello World!"}, "zh-cn"=>{"Hello World!"=>"\u4E16\u754C\u60A8\u597D\uFF01"}, "es-es"=>{"Hello World!"=>"Hola Mundo!"}}}
 
@@ -52,7 +96,7 @@ Let's pretty print that a bit:
 
 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")
+  client.utility.get_sso_link("myapp/users/123456", "fred")
   => "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.

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 # = RDoc 
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 Rake::RDocTask.new do |t|
   t.rdoc_dir = 'rdoc'
@@ -11,3 +11,19 @@ Rake::RDocTask.new do |t|
   t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'CHANGELOG', 'CREDITS', 'lib/**/*.rb')
 end
 
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rspec_opts = %w{--tag ~live}
+end
+
+desc "Run live specs"
+RSpec::Core::RakeTask.new("spec:live") do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+  t.rspec_opts = %w{--tag live}
+end

data/lib/one_sky.rb

@@ -1,11 +1,10 @@
-require 'json'
-require 'rest_client'
-require 'digest/md5'
-
 module OneSky
-  API_ROOT_URL = "https://api.oneskyapp.com/1"
-
-  autoload :Project, 'one_sky/project'
-
-  %w[ApiError].each { |e| const_set(e, Class.new(StandardError)) }
+  class ApiError < StandardError; end
 end
+
+require 'one_sky/client'
+require 'one_sky/platform'
+require 'one_sky/project'
+require 'one_sky/translation'
+require 'one_sky/utility'
+require 'one_sky/version'

data/lib/one_sky/client.rb

@@ -0,0 +1,80 @@
+require 'json'
+require 'rest_client'
+require 'digest/md5'
+
+module OneSky
+  
+  # Base implemention of an API client
+  # based on the one sky api version 2.
+  # 
+  #   http://developer.oneskyapp.com/api/list/v/2
+  #
+  class Client
+    attr_accessor :api_key, :api_secret
+
+    # 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)
+      raise ArgumentError, "api_key, api_secret cannot be nil." unless [api_key, api_secret].all?
+      @api_key, @api_secret = api_key, api_secret
+    end
+    
+    # Api version 2
+    API_ROOT_URL = "https://api.oneskyapp.com/2/".freeze
+    
+    def get(path, params = {}, options = nil)
+      fetch_response :get, path, params, options
+    end
+
+    def post(path, params = {}, options = nil)
+      fetch_response :post, path, params, options
+    end
+  
+    # Returns an API proxy for the Project Management API
+    def project(name)
+      Project.new(name, self)
+    end
+    
+    # Returns an API proxy for the Utility API
+    def utility
+      Utility.new(self)
+    end
+    
+    protected
+
+    # dev-hash = MD5( CONCATENATE( timestamp , YOUR_API_SECRET ) )
+    def authorization_params
+      timestamp = Time.now.to_i.to_s
+      {:"api-key" => self.api_key, :timestamp => timestamp, :"dev-hash" => Digest::MD5.hexdigest(timestamp + self.api_secret)}
+    end
+    
+    def fetch_response(http_verb, path, params, options)
+      options ||= {:content_type => "text/plain; charset=UTF-8"}
+      params = authorization_params.merge(params)
+      path = api_path(path)
+      
+      response = case http_verb
+      when :get
+        RestClient.get(path, {:params => params}.merge(options))
+      when :post
+        RestClient.post(path, params.merge(options))
+      else
+        raise "bad http verb"
+      end
+      
+      parse_response(response)
+    end
+    
+    def api_path(path)
+      URI.join(API_ROOT_URL, path.gsub(/^\//, "")).to_s
+    end
+
+    def parse_response(response)
+      # 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.body)
+
+      raise ApiError, response.body if response_hash.has_key?("response") and response_hash["response"] != "ok"
+      response_hash
+    end
+  end
+end

data/lib/one_sky/platform.rb

@@ -0,0 +1,36 @@
+module OneSky
+  
+  # Implements the Platform Management API for a given :platform_id
+  class Platform
+    
+    attr_accessor :platform_id, :client
+
+    # Provide the id of the platform, together with an instance of OneSky::Client.
+    def initialize(platform_id, client)
+      @platform_id = platform_id
+      @client = client
+    end
+    
+    # Get the information of the platform.
+    def details
+      get("platform/details")["platform"]
+    end
+    
+    # Get the details of activated locales for a platform.
+    def locales
+      get("platform/locales")["locales"]
+    end
+    
+    # Returns an API proxy for the Translation I/O API for this platform
+    def translation
+      Translation.new(platform_id, client)
+    end
+    
+    protected
+    
+    def get(path, params={})
+      client.get(path, params.merge(:"platform-id" => platform_id))
+    end
+
+  end
+end

data/lib/one_sky/project.rb

@@ -1,127 +1,35 @@
 module OneSky
-  # This is the main class used to interact with the OneSky API and maps to a project on their web site.
+  
+  # Implements the Project Management API for a given :project_name
   class Project
-    attr_accessor :api_key, :api_secret, :name
+    attr_accessor :project_name, :client
 
-    # 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
+    # Provide the name of the project, together with an instance of OneSky::Client.
+    def initialize(project_name, client)
+      @project_name = project_name
+      @client = client
     end
 
-    # Returns details about the project.
-    def details
-      get("/project/details")["project"]
-    end
-
-    # Returns available types to be specified when creating a new the project.
-    def types
-      get("/project/types")["types"]
-    end
-
-    # Returns an array of available languages.
-    def languages
-      get("/project/languages")["languages"]
-    end
-
-    # Returns info about your account. 
-    def info
-      get("/info")["application"]
-    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
+    # Return all platforms in a project.
+    def platforms
+      get("project/platforms")["platforms"]
     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"]
+    
+    # Get the information of the project.
+    def details
+      get("project/details")["project"]
     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
+    
+    # Returns an API proxy for the Platform Management API for the given platform_id.
+    def platform(platform_id)
+      Platform.new(platform_id, client)
     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 }
+    
+    def get(path, params={})
+      client.get(path, params.merge(:project => project_name))
     end
 
-    def authorization_params
-      timestamp = Time.now.to_i.to_s
-      {:project => @name, :"api-key" => @api_key, :timestamp => timestamp, :"dev-hash" => Digest::MD5.hexdigest(timestamp + @api_secret)}
-    end
- 
-    def get(path, params = {}, options = {:content_type => "text/plain; charset=UTF-8"})
-      params = authorization_params.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 = authorization_params.merge(params)
-      parse_response(RestClient.post([API_ROOT_URL, path].join, params.merge(options)))
-    end
-
-    def parse_response(response)
-      # 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