localio 0.0.23 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b34d3628cd466fa2c3e779ab9d3cd1e6e38f8d27
-  data.tar.gz: 1c5f6ca2433dd58363b2a95823a9461b5f32638c
+  metadata.gz: 37ebfdfd8bd72c867b84d975ce1f069db365fabf
+  data.tar.gz: d758c6f63079a4e3ff4c7b7e1b29dfdc93932054
 SHA512:
-  metadata.gz: 07e98e7291d6ac2f4ad1cda97b5ca39be7b154cd0b37418a29dd3926ace3218cf14ecc33b54570f2803a5faaefe0de28b415677f1d4aee9735a49dbc644faf72
-  data.tar.gz: 1b9bbd621abb3b5a2be60e222d8cf1722af14d890fa463f412a0e68d7331529c60be24a2406e8c970dc2bedc916fc30d9c9ccee1d41873ffb1e21aa4b31ccf7a
+  metadata.gz: 3ebb579abcb7071d11e5daac7df6d00c6ff85773908557067a0abaad63558c6cb8f15247813dc1f60581404a4c8e246ae4fdaeea99ed9e47b2a866f357f1f0ce
+  data.tar.gz: bd43ae7b036b857c47e8965ee4e5b0358d5162d4c3aa558d60d76f1c97a96f95e2260ffcc536621ec04744626391e8f6940901092dfdc987fa7d47aa03cad552

data/README.md

@@ -47,10 +47,8 @@ platform :ios
 
 output_path 'out/'
 
-source :google_drive,
-       :spreadsheet => '[Localizables] My Project!',
-       :login => 'your_email@gmail.com',
-       :password => 'your_password'
+source :xlsx,
+       :path => 'my_translations.xlsx'
 
 formatting :smart # This is optional, formatting :smart is used by default.
 ````
@@ -113,25 +111,47 @@ You will have to provide some required parameters too. Here is a list of all the
 Option                      | Description
 ----------------------------|-------------------------------------------------------------------------
 `:spreadsheet`              | (Req.) Title of the spreadsheet you want to use. Can be a partial match.
-`:login`                    | (Req.) Your Google login.
-`:password`                 | (Req.) Your Google password.
+`:login`                    | **DEPRECATED** This is deprecated starting version 0.1.0. Please remove it.
+`:password`                 | **DEPRECATED** This is deprecated starting version 0.1.0. Please remove it.
+`:client_id`                | (Req.) Your Google CLIENT ID.
+`:client_secret`            | (Req.) Your Google CLIENT SECRET.
+`:access_token`             | Your generated access token. You will get it the first time you log in and give permissions to your generated Google Developer Console application.
+
+Please take into account that from version 0.1.0 of Localio onwards we are using **Google OAuth2 authentication**, as the previous one with login/password has been deprecated by Google and cannot be access anymore starting April 20th 2015.
+
+Setting it up is a bit of a pain, although it is only required the first time and can be shared by all your projects:
+
+1. You have to create a new project in Google Developers Console for using Drive API. You can do that [here](https://console.developers.google.com/flows/enableapi?apiid=drive).
+2. After it is created you will be redirected to the credentials section (if not, just select under APIs and authentication in the sidebar the Credentials section), where you will click in the button labeled **Create new client ID**.
+3. Select the third option, the one that says something like **Installed Application**.
+4. Fill the form with whatever you want. For example, you could put Localio as the product name (the only thing required there).
+5. Select again the third option, **Installed Application**, and in the platform selector select the last one, **Others**.
+6. You will have all the necessary information in the next screen: Client ID and Client Secret.
+
+After doing all this, you are ready to add `:client_id` and `:client_secret` fields to your Locfile `source`.
+
+Then, the first time you run it, you will be prompted to follow some instructions. You will be asked to open a website, where you will be prompted for permission to use the Drive API. After you allow it, you will be given an authorization code, which you will have to paste in your terminal screen when prompted.
+
+After all this is done, you will be given in the `:access_token` in the output. Just add it to the `source` parameters, as you did with the id and secret before, and that's it. Hopefully you won't happen to repeat any of these steps for a long time.
 
-**NOTE** As it is a very bad practice to put your login and your password in a plain file, specially when you would want to upload your project to some repository, it is **VERY RECOMMENDED** that you use environment variables in here. Ruby syntax is accepted so you can use `ENV['GOOGLE_LOGIN']` and `ENV['GOOGLE_PASSWORD']` in here.
+**NOTE** As it is a very bad practice to put your sensitive information in a plain file, specially when you would want to upload your project to some repository, it is **VERY RECOMMENDED** that you use environment variables in here. Ruby syntax is accepted so you can use `ENV['CLIENT_SECRET']`, `ENV['CLIENT_ID']` and `ENV['ACCESS_TOKEN']` in here.
 
 For example, this.
 
 ````ruby
 source :google_drive,
        :spreadsheet => '[Localizables] My Project!',
-       :login => ENV['GOOGLE_LOGIN'],
-       :password => ENV['GOOGLE_PASSWORD']
+       :client_id => ENV['CLIENT_ID'],
+       :client_secret => ENV['CLIENT_SECRET'],
+       :access_token => ENV['ACCESS_TOKEN']
 ````
 
 And in your .bashrc (or .bash_profile, .zshrc or whatever), you could export those environment variables like this:
 
 ````ruby
-export GOOGLE_LOGIN="your_login"
-export GOOGLE_PASSWORD="your_password"
+export CLIENT_ID="your_client_id"
+export CLIENT_SECRET="your_client_secret"
+export ACCESS_TOKEN="your_access_token"
 ````
 
 ##### XLS

data/lib/localio/processors/google_drive_processor.rb

@@ -8,10 +8,23 @@ class GoogleDriveProcessor
     # Parameter validations
     spreadsheet = options[:spreadsheet]
     raise ArgumentError, ':spreadsheet required for Google Drive source!' if spreadsheet.nil?
+
+    # Deprecate :login & :password
     login = options[:login]
-    raise ArgumentError, ':login required for Google Drive source!' if login.nil?
+    raise ArgumentError, ':login is deprecated. You should use :client_id and :client_secret for secure OAuth2 authentication.' unless login.nil?
     password = options[:password]
-    raise ArgumentError, ':password required for Google Drive source!' if password.nil?
+    raise ArgumentError, ':password is deprecated. You should use :client_id and :client_secret for secure OAuth2 authentication.' unless password.nil?
+
+    # New authentication way
+    client_id = options[:client_id]
+    client_secret = options[:client_secret]
+    access_token = options[:access_token]
+
+    # We need client_id / client_secret if we dont have an access token
+    if access_token.nil?
+      raise ArgumentError, ':client_id required for Google Drive. Check how to get it here: https://developers.google.com/drive/web/auth/web-server' if client_id.nil?
+      raise ArgumentError, ':client_secret required for Google Drive. Check how to get it here: https://developers.google.com/drive/web/auth/web-server' if client_secret.nil?
+    end
 
     override_default = nil
     override_default = platform_options[:override_default] unless platform_options.nil? or platform_options[:override_default].nil?
@@ -19,9 +32,30 @@ class GoogleDriveProcessor
     # Log in and get spreadsheet
     puts 'Logging in to Google Drive...'
     begin
-      session = GoogleDrive.login(login, password)
-    rescue
-      raise 'Couldn\'t access Google Drive. Check your credentials in :login and :password'
+      if access_token.nil?
+        puts "No :access_token found. Let\'s proceed to get one!".red
+        client = Google::APIClient.new application_name: 'Localio', application_version: Localio::VERSION
+        auth = client.authorization
+        auth.client_id = client_id
+        auth.client_secret = client_secret
+        auth.scope =
+            "https://www.googleapis.com/auth/drive " +
+                "https://spreadsheets.google.com/feeds/"
+        auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
+        puts "1. Open this page in your browser:\n#{auth.authorization_uri}\n\n"
+        puts "2. Enter the authorization code shown in the page: "
+        auth.code = $stdin.gets.chomp
+        auth.fetch_access_token!
+        access_token = auth.access_token
+        puts '\n**IMPORTANT** You can store your access_token in the Locfile :source parameter for avoiding this step in the future:\n'
+        puts ":access_token => '#{access_token}'".yellow
+        puts '\n\n'
+      end
+      # Creates a session
+      session = GoogleDrive.login_with_oauth(access_token)
+    rescue => e
+      puts "Error: #{e.inspect}"
+      raise 'Couldn\'t access Google Drive. Check your values for :client_id and :client_secret, and delete :access_token if present (you might need to refresh its value so please remove it)'
     end
     puts 'Logged in!'
 
@@ -63,8 +97,8 @@ class GoogleDriveProcessor
     for column in 2..worksheet.max_cols
       col_all = worksheet[first_valid_row_index, column]
       col_all.each_line(' ') do |col_text|
-        default_language = col_text.downcase.gsub('*','') if col_text.include? '*'
-        languages.store col_text.downcase.gsub('*',''), column unless col_text.to_s == ''
+        default_language = col_text.downcase.gsub('*', '') if col_text.include? '*'
+        languages.store col_text.downcase.gsub('*', ''), column unless col_text.to_s == ''
       end
     end
 

data/lib/localio/version.rb

@@ -1,3 +1,3 @@
 module Localio
-  VERSION = "0.0.23"
+  VERSION = "0.1.0"
 end

data/localio.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   
-  spec.add_dependency "micro-optparse", "~> 1.1"
-  spec.add_dependency "google_drive", "0.3.10"
+  spec.add_dependency "micro-optparse", "~> 1.2"
+  spec.add_dependency "google_drive", "1.0.0"
   spec.add_dependency "spreadsheet", "~> 1.0"
   spec.add_dependency "simple_xlsx_reader", "~> 1.0"
   spec.add_dependency "nokogiri", "~> 1.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: localio
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.1.0
 platform: ruby
 authors:
 - Nacho Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google_drive
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.10
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.10
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: spreadsheet
   requirement: !ruby/object:Gem::Requirement