opengraph_transporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa0283f8d7638544d60cda64f99807201bb1a5e5
+  data.tar.gz: 8fcd12be282e33dbdb62fef653c3ee621b4df58c
+SHA512:
+  metadata.gz: d7dee52e5207f8e2ffcd78a56c4885373d7bc5d4bfd3d1d0e06caf97e3a93c6e4a12f5a70aa41ecb7309fd28e7b83fbca7c96b09cdbd004a9bed43b4d19c85d9
+  data.tar.gz: 8fd34a80d0b543ad24e37c5a33a6e3d779698a5953fe0fdc3dfb479b7b72bd17b8472a4a8880c9f480d788af067a953a1827c013c629307a54ed564c779b724d

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Barry Quigley
+
+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,45 @@
+# OpengraphTransporter
+
+opengraph_transporter is a Ruby console app that exports Facebook OpenGraph translations between Developer Apps. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opengraph_transporter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opengraph_transporter
+    
+    
+## Requirements
+
+* Ruby 1.9.3 or higher
+* Firefox 22.0.0 or higher
+
+## Usage
+
+1. Run opengraph_transporter
+2. Enter Source Facebook Developer App ID and App Secret
+3. Enter Destination Facebook Developer App ID and App Secret
+4. Enter App translations locale.
+5. Follow the prompts.
+
+
+```
+$ Please Enter Source Application Id
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/opengraph_transporter'
+  t.test_files = FileList['test/lib/opengraph_transporter/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/bin/opengraph_transporter

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+##                      $VERBOSE
+## -W0  NO Warnings     nil
+## -W1  Quiet           false
+## -W2  Verbose         true
+BEGIN { $VERBOSE = false }
+
+begin
+  require 'opengraph_transporter'
+rescue LoadError
+  require 'rubygems'
+  require 'opengraph_transporter'
+end
+
+# -----------------------------------------------------------------------
+# Main
+# -----------------------------------------------------------------------
+
+OpengraphTransporter::Base.run
+

data/lib/opengraph_transporter/base.rb

@@ -0,0 +1,214 @@
+module OpengraphTransporter 
+  class Base
+
+    class << self
+
+      @@translation = nil
+      @@user = {}
+
+      def run
+        setup
+        say("<%= color('Preparing Translations....', YELLOW, BOLD) %>")   
+        prepare
+        Common.show_translations_info(translation)
+        say("<%= color('Process existing Destination application Translations (#{Base.translation[:dst_app_name]} native stubs) ....', YELLOW, BOLD) %>")
+        run_export
+      end
+
+      def translation
+        @@translation
+      end
+      
+      def translation=(value)
+        @@translation = value
+      end
+
+      def user
+        @@user
+      end
+      
+      def user=(value)
+        @@user = value
+      end
+
+      def inspect
+        "<#{self.name} user: #{user} translation: #{translation.inspect} >"
+      end
+
+      def to_s
+        inspect
+      end
+     
+      private
+
+      def setup
+        display_app_splash
+        get_apps_details
+        self      
+      end
+
+      def run_export
+       translation[:dst_translation_arr] = Scraper.ingest_app_translations(translation[:destination_application_id], translation[:app_locale])
+       if translation[:dst_translation_arr].length == 0
+         say("No destination app <%= color('(#{Base.translation[:dst_app_name]})', RED, BOLD) %> Open Graph Translations found, please check that Open Graph stories exist and localization.")  
+       else
+         translation[:src_translation_arr] = Scraper.update_display_names!(translation[:src_translation_arr], translation[:src_app_name].to_s, translation[:dst_app_name].to_s)
+         translations_cleanup
+         say("<%= color('Export Translations....', YELLOW, BOLD) %>")  
+         choose do |menu|
+           menu.prompt = "This action will overwrite existing #{translation[:dst_app_name]} translations. Are you sure you want to export translations?"
+           menu.choice(:Yes) { 
+            say("....starting Export!")
+            Browser.export
+           }
+           menu.choices(:No) { say("...exiting Exporter!") }
+         end
+       end
+      end
+
+      def prepare 
+        src_translation_arr =  Common.get_application_translations(translation[:source_app_token], translation[:app_locale], false)
+        dst_translation_arr =  Common.get_application_translations(translation[:destination_app_token], translation[:app_locale], true)
+        translation[:src_translation_arr] = src_translation_arr
+        translation[:dst_translation_arr] = dst_translation_arr
+
+        if translation[:src_translation_arr].nil?
+          Common.show_arguments_info(translation)
+          say("<%= color('Invalid application data, please recheck application and locale settings.', RED, BOLD) %>")
+          exit
+        end
+      end
+
+      def get_apps_details(error_keys = [])
+        invalid_entries = false
+        initialize_translation
+       
+        translation.each do |key, val|
+          if val.empty? || error_keys.include?(key.to_s)
+            invalid_entries = true
+            case key 
+            when :source_application_id then translation[key] = ask_for_app_id(key).to_s
+            when :source_application_secret then translation[key] = ask_for_app_secret(key)
+            when :destination_application_id then translation[key] = ask_for_app_id(key).to_s
+            when :destination_application_secret then translation[key] = ask_for_app_secret(key)
+            else translation[key] = ask("\nPlease Enter <%= color('#{capitalize(key)}', GREEN, BOLD) %>", String)
+            end
+          end
+        end
+
+        if invalid_entries
+          validate_applications_data
+        end
+      end
+
+      def validate_applications_data
+        locales = generate_locales
+        error_keys = []
+        
+        if translation[:source_application_id].empty?  
+          error_keys << "source_application_id"
+        end
+        if translation[:source_application_secret].empty? 
+          error_keys << "source_application_secret"
+        end
+        if translation[:destination_application_id].empty? 
+          error_keys << "destination_application_token"
+        end
+        if translation[:destination_application_secret].empty?
+          error_keys << "destination_application_secret"
+        end 
+        if translation[:source_application_id].eql?(translation[:destination_application_id])
+          say("<%= color('Duplicated selection: ', RED, BOLD) %> please selection different source and destination applications. \n")
+          error_keys << "destination_application_id"  << "destination_application_secret"
+        end
+        if translation[:app_locale].empty? 
+          error_keys << "app_locale"
+        else
+          if !locales.include?(translation[:app_locale])
+            error_keys << "app_locale"
+          end
+        end
+  
+        if !error_keys.empty?
+          say("<%= color('Invalid Data: ', RED, BOLD) %> #{error_keys.join(' ')} \n")
+          choose do |menu|
+            menu.prompt = "Re-enter app details?"
+            menu.choice(:Yes) { 
+              get_apps_details(error_keys)
+            }
+            menu.choices(:No) { 
+              say("...exiting Exporter!") 
+              exit
+            }
+          end
+        else
+          get_app_specfics
+        end
+      end
+
+      def generate_locales
+        locales_arr = []   
+        app_root = File.expand_path(File.dirname(__FILE__))
+        fb_locales_doc = File.open(File.join(app_root, "/resources/FacebookLocales.xml"))
+        locales = Nokogiri::XML(fb_locales_doc)
+        
+        locales.xpath("//representation").each do |locale|
+          locales_arr << locale.text
+        end
+        
+        return locales_arr
+      end
+
+      def get_app_specfics
+        say("\n.....retrieving app tokens")
+        translation[:source_app_token] = Common.get_app_token(translation[:source_application_id], translation[:source_application_secret]) 
+        translation[:destination_app_token] = Common.get_app_token(translation[:destination_application_id], translation[:destination_application_secret]) 
+        
+        translation[:src_app_name] = Common.get_application_name(translation[:source_app_token], translation[:source_application_id]) 
+        translation[:dst_app_name] = Common.get_application_name(translation[:destination_app_token], translation[:destination_application_id]) 
+      end
+
+      def initialize_translation
+        @@translation ||= {:source_application_id => '', :source_application_secret => '', :destination_application_id => '', :destination_application_secret => '', :app_locale => '' }
+      end
+
+      def translations_cleanup
+         Common.update_destination_translations(translation)
+         Common.remove_empty_translations(translation)
+         Common.show_translations_info(translation)
+      end
+
+      def capitalize(sym)
+        sym.to_s.split('_').map(&:capitalize).join(' ')
+      end
+
+      def ask_for_app_id(translation_key)
+        ask("\nPlease Enter <%= color('#{capitalize(translation_key)}', GREEN, BOLD) %>", lambda { |id| id.to_s.strip } ) do |q| 
+          q.validate              = lambda { |p|  (p =~ /^\d{15}$/) != nil }
+          q.responses[:not_valid] = "Please enter a 15 digit App Id."
+        end
+      end
+
+      def ask_for_app_secret(translation_key)
+        ask("\nPlease Enter <%= color('#{capitalize(translation_key)}', GREEN, BOLD) %>", lambda { |id| id.to_s.strip } ) do |q| 
+          q.validate              = lambda { |p|  (p =~ /^[a-zA-Z0-9]{32}$/) != nil }
+          q.responses[:not_valid] = "Please enter a 32 character alphanumeric App Secret."
+        end
+      end
+
+      def display_app_splash
+        puts "\n"
+        splash = ConsoleSplash.new(6, 88)
+        splash.write_horizontal_pattern("||")
+        splash.write_vertical_pattern("||")
+        splash.write_center(-4, "Open Graph Translations Exporter")
+        splash.write_center(-3, "Version: #{OpengraphTransporter::VERSION}")
+        splash.splash
+        puts "\n"
+      end
+
+    end
+
+
+  end
+end

data/lib/opengraph_transporter/browser.rb

@@ -0,0 +1,99 @@
+module OpengraphTransporter
+  class Browser
+
+    MAX_TRANSLATION_PAGE_LIMIT = 30
+
+    class << self
+
+      def export
+        begin 
+          Watir.driver = :webdriver
+          @browser = Watir::Browser.new :firefox
+          @page_index_counter = 0
+          @translation_count_index = 0
+          @translation = Base.translation
+          @translation_arr = @translation [:dst_translation_arr].clone
+          fb_login
+
+          developer_translations_home_uri = "https://www.facebook.com/translations/admin/browse.php?search=&sloc=en_US&aloc=#{@translation[:app_locale]}&app=#{@translation[:destination_application_id]}"
+          @browser.goto developer_translations_home_uri
+          GracefulQuit.enable
+          parse_translation_rows
+
+        rescue Exception => e
+          say("An error occurred when generating automated browser, do you have FireFox installed? \n\n error: #{e}.")
+          exit
+        end
+      end
+
+      private
+
+      def parse_translation_rows
+         @translation_arr.each_with_index do |translation, index|
+           row_hash = "variant:" << translation[:native_hash]
+           translation_row = @browser.tr(:id, row_hash)
+           if translation_row.exists? && !translation[:translation].empty?
+             say("updating translation native hash: #{translation[:native_hash]} : #{translation[:translation]}")
+             translation_row.td(:class, /s_trans/).click
+             translation_row.textarea(:class, /uiTextareaAutogrow/).set translation[:translation]
+             translation_row.button(:id, /submit:/).click
+             sleep(0.25)
+             @translation_count_index += 1
+           end  
+           GracefulQuit.check
+         end    
+         process_next_page
+      end
+
+      def process_next_page
+        next_button = @browser.div(:class => "pagerpro_container").link(:text => /Next/)
+        if next_button.exists? && @page_index_counter < MAX_TRANSLATION_PAGE_LIMIT
+          begin
+            translations_page = @page_index_counter + 1
+            say("processing translation page.... #{translations_page + 1}")
+            @page_index_counter += 1
+            next_button.click
+            sleep(2.5)
+            parse_translation_rows
+          rescue Exception => e
+            say("Translation error: #{e}, carry on.")
+            parse_translation_rows
+          end
+        else
+          complete_translations_process
+        end
+      end
+
+      def complete_translations_process
+         fb_logout
+         open_graph_translations_stats
+      end
+
+      def fb_login
+         say("\n.....logging into Facebook")
+         @browser.goto "https://www.facebook.com"
+         @browser.text_field(id: "email").set  Base.user[:fb_username] 
+         @browser.text_field(id: "pass").set  Base.user[:fb_password] 
+         @browser.label(id: "loginbutton").click
+      end
+
+      def fb_logout
+         say(".....logging out of Facebook \n")
+         @browser.div(id: "userNavigationLabel").click
+         @browser.label(class: "uiLinkButton navSubmenu").click
+         @browser.close
+      end
+
+      def open_graph_translations_stats
+         say("<%= color('\n***********************************************************************************************************', GREEN, BOLD) %>")
+         say("Source Application: <%= color('#{@translation[:src_app_name]}', GREEN, BOLD) %>")
+         say("Destination Application: <%= color('#{@translation[:dst_app_name]}', GREEN, BOLD) %>")
+         say("Export completed: <%= color('#{@translation[:dst_translation_arr].length} Open Graph translations processed', GREEN, BOLD) %>")
+         say("<%= color('***********************************************************************************************************\n', GREEN, BOLD) %>")
+      end
+
+    end
+
+  end
+end
+

data/lib/opengraph_transporter/common.rb

@@ -0,0 +1,159 @@
+module OpengraphTransporter
+  class Common
+
+    FB_GRAPH_HOST = "https://graph.facebook.com"
+
+    class << self
+
+      def update_destination_translations(translation)
+        say(".....updating translation text")
+        translation[:dst_translation_arr].each do |dst_translation| 
+          translation[:src_translation_arr].each do |src_translation| 
+            if dst_translation[:native].eql?(src_translation['native'])
+              dst_translation[:translation] = src_translation['translation']
+            end
+          end
+        end
+      end
+
+      def remove_empty_translations(translation)
+        say(".....remove empty translations")
+         translation[:dst_translation_arr].each_with_index do |dst_translation, index| 
+           if dst_translation[:translation].empty?
+             translation[:dst_translation_arr].delete_at(index)
+           end 
+        end
+      end
+
+      def get_application_translations(app_token, app_locale, include_hash)
+        if include_hash
+          fql = %Q{select native_hash, native_string, best_string FROM translation WHERE locale = "#{app_locale}"}
+          mappings = {"native_hash" => "native_hash", "native_string" => "native", "best_string" => "translation"}
+        else
+          fql = %Q{select native_string, best_string FROM translation WHERE locale = "#{app_locale}"}
+          mappings = {"native_string" => "native", "best_string" => "translation"}
+        end
+        
+        params = {:access_token => app_token, :q => fql}
+        request = 'fql'
+        app_translations = fb_graph_call(request, params)['data']
+        @app_translations = Array.new
+        
+        app_translations.each do |translation| 
+          @app_translations.push(Hash[translation.map {|k, v| [mappings[k], v] }])
+        end
+         
+        if !include_hash
+          @app_translations = @app_translations.uniq!
+        end
+        return @app_translations
+      end
+
+      def get_application_details(app_token, app_id)
+        fql = %Q{select display_name, description, link, namespace from application where app_id = #{app_id}}
+        params = {:access_token => app_token, :q => fql}
+        request = 'fql'
+        response = fb_graph_call(request, params)
+        return response['data'][0]
+      end
+
+      def show_translations_info(translation)
+        say("<%= color('\n***********************************************************************************************************', YELLOW, BOLD) %>")
+        say("Source Application ID:      <%= color('#{translation[:source_application_id]}', BOLD) %>    Existing translations: <%= color('#{translation[:src_translation_arr].length}', YELLOW, BOLD) %>    Application Name: <%= color('#{translation[:src_app_name]}', BOLD) %>")
+        say("Destination Application ID: <%= color('#{translation[:destination_application_id]}', BOLD) %>    Existing translations: <%= color('#{translation[:dst_translation_arr].length}', YELLOW, BOLD) %>    Application Name: <%= color('#{translation[:dst_app_name]}', BOLD) %>")
+        say("<%= color('***********************************************************************************************************\n', YELLOW, BOLD) %>")
+      end
+
+
+      def show_arguments_info(translation)
+        say("<%= color('\n***********************************************************************************************************', YELLOW, BOLD) %>")
+        say("Source Application ID:      <%= color('#{Base.translation[:source_application_id]}', YELLOW, BOLD) %>     Application Name: <%= color('#{Base.translation[:src_app_name]}', YELLOW, BOLD) %>")
+        say("Destination Application ID: <%= color('#{Base.translation[:destination_application_id]}', YELLOW, BOLD) %>     Application Name: <%= color('#{Base.translation[:dst_app_name]}', YELLOW, BOLD) %>")
+        say("Selected Locale:      <%= color('#{Base.translation[:app_locale]}', YELLOW, BOLD) %>")
+        say("<%= color('***********************************************************************************************************\n', YELLOW, BOLD) %>")
+      end
+
+      def get_application_name(app_token, app_id)
+        params = {:access_token => app_token}
+        request = "#{app_id}"
+        response = fb_graph_call(request, params)
+        if response.nil?
+          show_arguments_info(translation)
+          say("<%= color('Invalid application data, please recheck application and locale settings.', RED, BOLD) %>")
+          exit
+        end
+        return response['name']
+      end
+
+      def get_app_token(app_id, app_secret)
+        params = {
+          :client_id => app_id,
+          :client_secret => app_secret,
+          :grant_type => 'client_credentials'
+        }
+        path = "/oauth/access_token"
+        response = fb_graph_call(path, params, {:format => :text})
+        
+        if response.nil?
+          say("<%= color('Invalid Data:', RED, BOLD) %> please recheck source and destination app_id and app_secret.")
+          exit
+        end
+
+        dummy = Addressable::URI.new
+        dummy.query = response
+        access_token = dummy.query_values["access_token"]
+
+        return access_token
+      end
+
+
+      private
+
+      def fb_graph_call(path, params = {}, options = {})
+        clnt = HTTPClient.new
+        uri = Addressable::URI.parse(FB_GRAPH_HOST)
+        uri.path = path
+        query = params
+        # default to JSON response
+        options = {:format => :json}.merge(options)
+        begin
+          response = clnt.get(uri, query)
+          if response.status == 200
+            case options[:format]
+            when :text then response.body
+            else JSON.parse(response.content)
+            end
+          end
+        rescue StandardError => e
+          say("Graph Call error: #{e}")
+          say("...exiting Exporter!")
+          exit
+          # raise e
+        end
+      end
+
+      # unused
+      def write_csv(translations_arr)
+        unless translations_arr.length == 0
+          csv_file_name = "appid_#{@translation[:source_application_id]}.csv"
+          csv_tmp_file = Tempfile.new(csv_file_name)
+          headers_arr = Array.new
+          translations_arr[0].each_key {|key| headers_arr.push(key) }
+          
+          CSV.open(csv_tmp_file, "w") do |csv|
+            csv << headers_arr
+            translations_arr.each do |el|
+              csv << el.values
+            end 
+          end
+          
+          send_file csv_tmp_file, :type => 'text/csv', :disposition => 'download', :filename => csv_file_name
+          csv_tmp_file.close
+          csv_tmp_file.unlink
+        end
+      end
+
+    end
+
+  end
+end

data/lib/opengraph_transporter/gracefulquit.rb

@@ -0,0 +1,33 @@
+require "singleton"
+module OpengraphTransporter
+  
+  class GracefulQuit
+    include Singleton
+
+    attr_accessor :breaker
+
+    def initialize
+      self.breaker = false
+    end
+
+    class << self
+
+      def enable
+        trap('INT') {
+          yield if block_given?
+          self.instance.breaker = true
+        }
+      end
+
+      def check(message = "Quitting Exporter")
+        if self.instance.breaker
+          yield if block_given?
+          puts message
+          exit
+        end
+      end
+
+    end
+
+  end
+end