phraseapp-rubymotion 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 161e0947aa5f4e4b88550e5b5bbf45410a8a485d
+  data.tar.gz: 0a709e07f3c60a40a6f3673380257a7f52cf871d
+SHA512:
+  metadata.gz: 4d92796eac55fd7422e0ab047e3bd46570cb2cfba105f4dc5a837a05501d25bab048b681ebaa892c3e83beb3444f68f6e29100d4fc8b2c8016be498379a55e97
+  data.tar.gz: d92f102fd37bb3533837e890f9344e24b233149936ee3d4c105adb123e43c6a6e973aa25541a958da5bc5bf481fdfc0594b47e3163826bb273df280d9d921788

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in motion-phrase.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 docstun
+
+MIT License
+
+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.md

@@ -0,0 +1,98 @@
+# phraseapp-rubymotion
+
+phraseapp-rubymotion lets you connect your RubyMotion application to PhraseApp and enables you to benefit from the best internationalization workflow for your (iOS) projects.
+
+It lets you use iOS Localizable.strings files to store and read translations but at the same time work on your translation files collaboratively with translators, developers and product managers.
+
+[Learn more about PhraseApp](https://phraseapp.com/)
+
+## Installation
+
+Using the service requires a PhraseApp account. Just sign up at [phraseapp.com/signup](https://phraseapp.com/signup) and get your free trial account (we offer free plans for small and open source projects).
+
+You can skip the introduction wizard and simply create your first project to get your Auth Token directly from the project overview in PhraseApp.
+
+### Install the Gem
+
+Add this line to your application's Gemfile:
+
+    gem 'phraseapp-rubymotion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phraseapp-rubymotion
+    
+Require the gem (unless you use bundler):
+
+```ruby
+require 'phraseapp-rubymotion'
+```
+    
+### Configure PhraseApp
+
+Add the Auth Token to your application's Rakefile:
+
+```ruby
+Motion::Project::App.setup do |app|
+  app.name = "Test Application"
+  app.development do
+    app.phraseapp do
+      app.phraseapp.enabled = true
+      app.phraseapp.access_token = "YOUR_AUTH_TOKEN"
+      app.phraseapp.project_id = "YOUR_PROJECT_ID"
+    end
+  end
+end
+```
+
+This will automatically create the `phraseapp_config.rb` configuration file in your app folder during every build process. 
+
+**Please make sure that you only enable PhraseApp in development mode and never in release mode!**
+
+## Usage
+
+Using PhraseApp with phraseapp-rubymotion enables you to:
+
+Send new translations to the PhraseApp API automatically without having to write them into your Localizable.strings file or uploading them - just by browsing the app.
+
+### Localizing Strings ###
+
+The first step towards a localized app is to localize all strings by extending them with their localized counterparts. This can be done by simply calling the `#__` method on each string that is implemented by phraseapp-rubymotion:
+
+```ruby
+"Hello World"
+```
+	
+now becomes:
+
+```ruby
+"Hello World".__
+```
+	
+or (when using a fallback translation):
+
+```ruby	
+"Hello World".__("My fallback translation")
+```
+	
+Of course you can use more generic names for your keys as well, such as:
+
+```ruby
+"HOME_WELCOME_BUTTON_LABEL".__
+```
+	
+[Learn more about localization in iOS](https://developer.apple.com/internationalization/)
+
+### Browsing translations in your app
+
+Simply build and run your app (in the simulator). When in development mode, phraseapp-rubymotion will send all of your localized strings to PhraseApp automatically! Log into your [PhraseApp account](https://phraseapp.com/account/login) and check your newly created translation keys. If you already have your localization files in the correct place, it will transmit translations as well.
+
+
+## Support
+
+* [PhraseApp Documentation](https://phraseapp.com/docs)
+* [PhraseApp Support Channel](https://phraseapp.com/support)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/motion/project/phrase.rb

@@ -0,0 +1,74 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+class PhraseAppConfig
+  attr_accessor :access_token, :enabled, :project_id
+
+  CONFIG_FILE = './app/phraseapp_config.rb'
+
+  def initialize(config)
+    @config = config
+    @enabled = false
+  end
+
+  def access_token=(access_token)
+    @access_token = access_token
+    create_phraseapp_config_file
+  end
+
+  def project_id=(project_id)
+    @project_id = project_id
+    create_phraseapp_config_file
+  end
+
+  def enabled=(enabled)
+    @enabled = enabled
+    create_phraseapp_config_file
+  end
+
+
+
+private
+  def create_phraseapp_config_file
+    return unless @access_token
+
+    if !config_file_exists? or config_file_content_outdated?
+      File.open(CONFIG_FILE, 'w') { |f| f.write(config_file_content) }
+    end
+    files = @config.files.flatten
+    files.unshift(CONFIG_FILE) unless files.find { |f| File.expand_path(f) == File.expand_path(CONFIG_FILE) }
+  end
+
+  def config_file_exists?
+    File.exist?(CONFIG_FILE)
+  end
+
+  def config_file_content_outdated?
+    config_file_exists? && File.read(CONFIG_FILE) != config_file_content
+  end
+
+  def config_file_content
+    content = <<EOF
+# This file is automatically generated. Do not edit.
+PHRASEAPP_ENABLED = #{enabled}
+PHRASEAPP_ACCESS_TOKEN = "#{access_token}"
+PHRASEAPP_PROJECT_ID = "#{project_id}"
+EOF
+    content
+  end
+end
+
+module Motion
+  module Project
+    class Config
+      variable :phraseapp
+
+      def phraseapp
+        @phraseapp ||= PhraseAppConfig.new(self)
+        yield @phraseapp if block_given?
+        @phraseapp
+      end
+    end
+  end
+end

data/lib/phraseapp-rubymotion.rb

@@ -0,0 +1,19 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require "motion/project/phrase"
+require "motion-cocoapods"
+require "phraseapp-ruby"
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), 'phraseapp-rubymotion/**/*.rb')).each do |file|
+    app.files.unshift(file)
+  end
+
+  app.files.unshift("./app/phraseapp_config.rb")
+  
+  app.pods do
+    pod 'AFNetworking', '>= 2.5.0'
+  end
+end

data/lib/phraseapp-rubymotion/api_client.rb

@@ -0,0 +1,110 @@
+module MotionPhrase
+  class ApiClient
+    API_CLIENT_IDENTIFIER = "PhraseApp RubyMotion " + MotionPhrase::VERSION
+    API_BASE_URI = "https://api.phraseapp.com/v2/"
+
+    def self.sharedClient
+      Dispatch.once { @instance ||= new }
+      @instance
+    end
+
+    def store(keyName, content, fallbackContent, currentLocale)
+      return unless access_token_present? && project_id_present?
+      content ||= fallbackContent
+      client.GET("projects/#{project_id}/locales", parameters:{}, success:lambda {|task, responseObject|
+        responseObject.each do |x|
+          if x["default"]
+            locale_id = x["id"]
+            storeKey({name: keyName}, locale_id, content, keyName)
+          end
+        end
+      }, failure:lambda {|task, error|
+        log "Failed to get locales"
+      })
+    end
+
+    def storeKey(data, locale_id, content, keyName)
+      client.POST("projects/#{project_id}/keys", parameters:data, success:lambda {|task, responseObject|
+        log "Key stored [#{data.inspect}]"
+        
+        client.POST("projects/#{project_id}/keys/search", parameters:{q: "name:#{keyName}"}, success:lambda {|task, responseObject|
+          storeTranslation(content, locale_id, responseObject[0]["id"])
+        }, failure:lambda {|task, error|
+          log "Failed to get KeyID [#{data.inspect}]"
+        })
+      }, failure:lambda {|task, error|
+        if error.userInfo['com.alamofire.serialization.response.error.data'].to_s.include?('has already been taken')
+          log "Key [#{data.inspect}] is already stored"
+          
+          client.POST("projects/#{project_id}/keys/search", parameters:{q: "name:#{keyName}"}, success:lambda {|task, responseObject|
+            storeTranslation(content, locale_id, responseObject[0]["id"])
+          }, failure:lambda {|task, error|
+            log "Failed to get KeyID [#{data.inspect}]"
+          })
+        else
+          log "Error while storing Key [#{data.inspect}]"
+          log error.localizedDescription
+        end
+      })
+    end
+
+    def storeTranslation(content, locale_id, key_id)
+      data = {
+        content: content,
+        locale_id: locale_id,
+        key_id: key_id
+      }
+      client.POST("projects/#{project_id}/translations", parameters:data, success:lambda {|task, responseObject|
+        log "Translation stored [#{data.inspect}]"
+      }, failure:lambda {|task, error|
+        if error.userInfo['com.alamofire.serialization.response.error.data'].to_s.include?('has already been taken')
+          log "Translation is already stored [#{data.inspect}] "
+        else
+          log "Error while storing Translation [#{data.inspect}]"
+          log error.localizedDescription
+        end
+      })
+    end
+
+  private
+    def client
+      Dispatch.once do
+        @client = begin
+          _client = AFHTTPSessionManager.alloc.initWithBaseURL(NSURL.URLWithString(API_BASE_URI))
+          _client.requestSerializer.setValue("token #{access_token}", forHTTPHeaderField: "Authorization")
+          _client
+        end
+      end
+      @client
+    end
+
+    def log(msg="")
+      $stdout.puts "PHRASEAPP: #{msg}"
+    end
+
+    def access_token
+      if defined?(PHRASEAPP_ACCESS_TOKEN)
+        PHRASEAPP_ACCESS_TOKEN
+      else
+        nil
+      end
+    end
+
+    def access_token_present?
+      !access_token.nil? && access_token != ""
+    end
+
+    def project_id
+      if defined?(PHRASEAPP_PROJECT_ID)
+        PHRASEAPP_PROJECT_ID
+      else
+        nil
+      end
+    end    
+
+    def project_id_present?
+      !project_id.nil? && project_id != ""
+    end
+
+  end
+end

data/lib/phraseapp-rubymotion/nsstring.rb

@@ -0,0 +1,41 @@
+class NSString
+  def _localized(value=nil, table=nil)
+    @localized = NSBundle.mainBundle.localizedStringForKey(self, value:value, table:table)
+    store(self, @localized, value, table) if phraseEnabled?
+    @localized
+  end
+  alias __ _localized
+
+private
+  def store(key, localized, defaultValue=nil, table=nil)
+    @client = MotionPhrase::ApiClient.sharedClient
+    @client.store(key, localized, defaultValue, currentLocaleName)
+  end
+
+  def phraseEnabled?
+    PHRASEAPP_ENABLED == true && development?
+  end
+
+  def currentLocaleName
+    currentLocale.localeIdentifier
+  end
+
+  # @return [NSLocale] locale of user settings
+  def currentLocale
+    languages = NSLocale.preferredLanguages
+    if languages.count > 0
+      return NSLocale.alloc.initWithLocaleIdentifier(languages.first)
+    else
+      return NSLocale.currentLocale
+    end
+  end
+
+  def environment
+    RUBYMOTION_ENV
+  end
+
+  def development?
+    environment == 'development'
+  end
+
+end

data/lib/phraseapp-rubymotion/version.rb

@@ -0,0 +1,3 @@
+module MotionPhrase
+  VERSION = "1.0.0"
+end

data/phraseapp-rubymotion.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phraseapp-rubymotion/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "phraseapp-rubymotion"
+  gem.version       = MotionPhrase::VERSION
+  gem.authors       = ["PhraseApp"]
+  gem.email         = ["info@phraseapp.com"]
+  gem.description   = "RubyMotion library for PhraseApp"
+  gem.summary       = "Connect your RubyMotion application to PhraseApp for the best i18n experience"
+  gem.homepage      = "https://github.com/phrase/phraseapp-rubymotion"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'phraseapp-ruby'
+  gem.add_dependency 'motion-cocoapods'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: phraseapp-rubymotion
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PhraseApp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phraseapp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion-cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RubyMotion library for PhraseApp
+email:
+- info@phraseapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/motion/project/phrase.rb
+- lib/phraseapp-rubymotion.rb
+- lib/phraseapp-rubymotion/api_client.rb
+- lib/phraseapp-rubymotion/nsstring.rb
+- lib/phraseapp-rubymotion/version.rb
+- phraseapp-rubymotion.gemspec
+homepage: https://github.com/phrase/phraseapp-rubymotion
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Connect your RubyMotion application to PhraseApp for the best i18n experience
+test_files: []