one_sky 2.0.0 → 2.0.1

data/lib/one_sky/translation.rb

@@ -1,10 +1,10 @@
 module OneSky
-  
+
   # Implements the Translation I/O API for a given :platform_id
   class Translation
-    
+
     attr_reader :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
@@ -13,97 +13,101 @@ module OneSky
 
     # Add new strings to be translated.
     #   expects an array of strings, or an array of hashes [{:string_key => k, :string => v}, ...]
-    def input_strings(strings)
-      post("string/input", :input => format_input_strings(strings))
+    def input_strings(strings, options={})
+      params = {:input => format_input_strings(strings)}
+      if options[:tag] # include the :tag if there is one
+        params[:tag] = options[:tag]
+      end
+      post("string/input", params)
     end
-    
+
     # Add new strings to be translated.
     #   expects a string, or a hash of {:string_key => k, :string => v}
-    def input_string(string)
-      input_strings([string])
+    def input_string(string, options={})
+      input_strings([string], options)
     end
-    
+
     # Add new strings to be translated.
     #   expects a hash of {"string_key1" => "String 1", "string_key2" => "String 2"}
-    def input_phrases(phrases)
+    def input_phrases(phrases, options={})
       strings = phrases.map do |string_key, string|
         {:string_key => string_key, :string => string}
       end
-      input_strings(strings)
+      input_strings(strings, options)
     end
-    
+
     # Add translation to a string.
     def translate(string_key, locale, translation)
       post("string/translate", :"string-key" => string_key, :locale => locale, :translation => translation)
     end
-    
+
     # Get the strings with translations.
     def output
       get_output
     end
-    
+
     # Get the strings for a particular locale.
     def output_for_locale(locale)
       get_output(locale)
     end
-    
+
     YAML_FORMAT = "RUBY_YAML".freeze
     PO_FORMAT = "GNU_PO".freeze
-    
+
     # I don't believe these work right now.
-    
+
       # Upload a string file to add new strings. In RUBY_YAML format.
       def upload_yaml(file)
         upload_file(file, YAML_FORMAT)
       end
-    
+
       # Upload a string file to add new strings. In GNU_PO format.
       def upload_po(file)
         upload_file(file, PO_FORMAT)
       end
-    
+
     # Download strings and translations as string file. In RUBY_YAML format.
     def download_yaml(locale)
       download_file(locale, YAML_FORMAT)
     end
-    
+
     # Download strings and translations as string file. In GNU_PO format.
     def download_po(locale)
       download_file(locale, PO_FORMAT)
     end
-    
+
     protected
-    
+
     # Get the strings with translations.
     def get_output(locale=nil)
       options = {}
       options[:locale] = locale if locale
-      
+
       get("string/output", options)["translation"]
     end
-    
+
     # Upload a string file to add new strings.
     def upload_file(file, format)
       post("string/upload", :file => file, :format => format)
     end
-    
+
     # Download strings and translations as string file.
     def download_file(locale, format)
       get("string/download", :locale => locale, :format => format)
     end
-    
+
     def get(path, params={})
       client.get(path, params.merge(:"platform-id" => platform_id))
     end
-    
+
     def post(path, params={})
       client.post(path, params.merge(:"platform-id" => platform_id))
     end
-    
+
     def format_input_strings(strings)
       JSON.dump(strings.map{|string| format_input_string(string)})
     end
-    
+
     def format_input_string(string)
       case string
       when String
@@ -114,7 +118,7 @@ module OneSky
         raise "input string must either be a string, or a hash"
       end
     end
-    
+
     # convert to "string-key" not "string_key"
     def dashify_string_hash(string_hash)
       output = Hash.new
@@ -126,4 +130,4 @@ module OneSky
     end
 
   end
-end
+end

data/lib/one_sky/version.rb

@@ -1,3 +1,3 @@
 module OneSky
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/one_sky.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "one_sky"
   s.version     = OneSky::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Junjun Olympia", "3dd13 Lau", "Matthew Rudy Jacobs"]
+  s.authors     = ["Junjun Olympia", "Eddie Lau", "Matthew Rudy Jacobs"]
   s.email       = ["romeo.olympia@gmail.com", "tatonlto@gmail.com", "matthewrudyjacobs@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/one_sky"
+  s.homepage    = "http://developer.oneskyapp.com/"
   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.}
 

data/spec/translation_spec.rb

@@ -5,70 +5,91 @@ describe OneSky::Translation do
   let(:secret)  { "secret" }
   let(:project_name) { "some-project" }
   let(:platform_id) { 123 }
-  
+
   let(:client) { OneSky::Client.new(api_key, secret) }
   let(:project) { client.project(project_name) }
   let(:platform) { project.platform(platform_id) }
   let(:translation) { platform.translation }
-  
+
   describe "input_strings" do
-    
+
     let(:string_array) {
       ["test1", "test2"]
     }
-    
+
     let(:hash_array) {
       [{:string => "test1"}, {:string => "test2"}]
     }
-    
+
+
     context "with an array of strings" do
       it "calls /string/input" do
         client.should_receive(:post).with("string/input", :input => JSON.dump(hash_array), :"platform-id" => platform_id)
-        
+
         translation.input_strings(string_array)
       end
     end
-    
+
+    context "with an array of strings and tag" do
+      it "calls /string/input" do
+        client.should_receive(:post).with("string/input", :input => JSON.dump(hash_array), :tag => "tagged", :"platform-id" => platform_id)
+
+        translation.input_strings(string_array, :tag => "tagged")
+      end
+    end
+
     context "with an array of hashes" do
       it "calls /string/input" do
         client.should_receive(:post).with("string/input", :input => JSON.dump(hash_array), :"platform-id" => platform_id)
-        
+
         translation.input_strings(hash_array)
       end
     end
-    
+
     context "with a complex array of hashes" do
       it "dasherizes the keys" do
         original = [{:string => "Test 1", :string_key => "test1"}]
         dasherized = [{:string => "Test 1", :"string-key" => "test1"}]
-        
+
         client.should_receive(:post).with("string/input", :input => JSON.dump(dasherized), :"platform-id" => platform_id)
-        
+
         translation.input_strings(original)
        end
     end
   end
-  
+
   describe "input_string" do
     it "defers to input_strings" do
-      translation.should_receive(:input_strings).with(["test1"])
+      translation.should_receive(:input_strings).with(["test1"], {})
       translation.input_string("test1")
     end
+
+    it "passes on a :tag" do
+      translation.should_receive(:input_strings).with(["test1"], {:tag => "tagged"})
+      translation.input_string("test1", :tag => "tagged")
+    end
+
   end
-  
+
   describe "input_phrases" do
     it "defers to input_strings" do
-      translation.should_receive(:input_strings).with([{:string_key => "test1", :string => "Test 1"}])
+      translation.should_receive(:input_strings).with([{:string_key => "test1", :string => "Test 1"}], {})
       translation.input_phrases("test1" => "Test 1")
     end
+
+    it "passes on a :tag" do
+      translation.should_receive(:input_strings).with([{:string_key => "test1", :string => "Test 1"}], {:tag => "tagged"})
+      translation.input_phrases({"test1" => "Test 1"}, :tag => "tagged")
+    end
+
   end
-  
+
   describe "translate" do
-    
+
     let(:string_key) { "test1" }
     let(:locale) { "en_US" }
     let(:string) { "Test 1" }
-    
+
     it "calls /string/translate" do
       client.should_receive(:post).with(
         "string/translate",
@@ -77,13 +98,13 @@ describe OneSky::Translation do
         :translation => string,
         :"platform-id" => platform_id
       )
-      
+
       translation.translate(string_key, locale, string)
     end
   end
-  
+
   describe "output" do
-    
+
     let(:example) do
       {
           "translation" => {
@@ -108,12 +129,12 @@ describe OneSky::Translation do
           "md5" => "95e6198f16ea363291dfa9bc18282545"
       }
     end
-    
+
     it "calls /string/output" do
       client.should_receive(:get).with("string/output", :"platform-id" => platform_id).and_return(example)
       translation.output.should == example["translation"]
     end
-    
+
     context "for_locale" do
       it "calls /string/output with the locale" do
         client.should_receive(:get).with("string/output", :"platform-id" => platform_id, :locale => "en_US").and_return(example)

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: one_sky
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
 - Junjun Olympia
-- 3dd13 Lau
+- Eddie Lau
 - Matthew Rudy Jacobs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000 Z
+date: 2012-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70215713483240 !ruby/object:Gem::Requirement
+  requirement: &70150153158340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70215713483240
+  version_requirements: *70150153158340
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70215713396900 !ruby/object:Gem::Requirement
+  requirement: &70150153157440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70215713396900
+  version_requirements: *70150153157440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70215713808380 !ruby/object:Gem::Requirement
+  requirement: &70150153156480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70215713808380
+  version_requirements: *70150153156480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70215713741580 !ruby/object:Gem::Requirement
+  requirement: &70150153156020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70215713741580
+  version_requirements: *70150153156020
 - !ruby/object:Gem::Dependency
   name: time_freeze
-  requirement: &70215713707880 !ruby/object:Gem::Requirement
+  requirement: &70150153155640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215713707880
+  version_requirements: *70150153155640
 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.
@@ -105,7 +105,7 @@ files:
 - spec/spec_helper.rb
 - spec/translation_spec.rb
 - spec/utility_spec.rb
-homepage: http://rubygems.org/gems/one_sky
+homepage: http://developer.oneskyapp.com/
 licenses: []
 post_install_message: 
 rdoc_options: []