transifex-interface-ruby 0.0.1

data/Rakefile

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

data/lib/transifex.rb

@@ -0,0 +1,87 @@
+require 'net/http'
+require 'multi_json'
+require 'yaml'
+require 'uri'
+require 'digest/md5'
+
+require "transifex/version"
+require "transifex/resource_components/translation_components/utilities"
+require "transifex/crud_requests"
+require "transifex/errors"
+require "transifex/formats"
+require "transifex/project"
+require "transifex/projects"
+require "transifex/json"
+require "transifex/languages"
+require "transifex/language"
+require "transifex/project_components/language"
+require "transifex/project_components/language_components/coordinators"
+require "transifex/project_components/language_components/reviewers"
+require "transifex/project_components/language_components/translators"
+require "transifex/project_components/languages"
+require "transifex/resource"
+require "transifex/resource_components/content"
+require "transifex/resource_components/source"
+require "transifex/resource_components/stats"
+require "transifex/resource_components/translation"
+require "transifex/resource_components/translation_components/string"
+require "transifex/resource_components/translation_components/strings"
+require "transifex/resources"
+
+
+
+module Transifex
+  
+  class Configuration 
+    attr_accessor :client_login, :client_secret, :root_url
+
+    def root_url
+      @root_url ||= "https://www.transifex.com/api/2"      
+    end 
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  def self.build_request_url(url='')
+    URI(self.configuration.root_url + url)    
+  end
+
+  def self.query_api(method, url, params={})
+    uri = build_request_url(url)
+
+    res = Net::HTTP.start(uri.host, 80) do |http|
+      req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, request_headers)
+      req.basic_auth self.configuration.client_login, self.configuration.client_secret
+      req.body = Transifex::JSON.dump(params)
+      http.request req
+    end
+
+    begin
+      data = Transifex::JSON.load(res.body.nil? ? '' : res.body)
+    rescue
+      data = res.body
+    end
+
+    unless (res.is_a? Net::HTTPOK) || (res.is_a? Net::HTTPCreated) || (res.is_a? Net::HTTPNoContent)
+      error = TransifexError.new(uri, res.code, data)
+      raise error
+    end    
+
+    data
+  end
+
+  def self.request_headers    
+    request_headers = {      
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json',
+      'User-Agent' => "Transifex-interface-ruby/#{Transifex::VERSION}"
+    }    
+  end
+end

data/lib/transifex/crud_requests.rb

@@ -0,0 +1,99 @@
+module Transifex
+  module CrudRequests
+    class << self      
+      def generate_url(object, params = {})
+        class_name_string = object.class.name.split("::").last.downcase.to_s
+        url = ""
+        if object.class.respond_to?(:parents)
+          object.class.parents.map{|parent| url += "/" + parent.to_s + "/" + object.instance_variable_get("@" + parent.to_s + "_slug")}                      
+        end          
+        url += "/" + class_name_string
+        url += "/" + object.instance_variable_get("@" + class_name_string + "_slug") if object.instance_variable_defined?("@" + class_name_string + "_slug")
+        params.each do |param| 
+          url = add_param(url, param[0], param[1])
+        end
+        url
+      end
+
+      def add_param(url, param_name, param_value)
+        uri = URI(url)
+        params = URI.decode_www_form(uri.query || []) << [param_name, param_value]
+        uri.query = URI.encode_www_form(params)
+        uri.to_s
+      end
+    end
+
+    module Fetch
+      module InstanceMethods
+        def fetch(options = {})
+          url = CrudRequests.generate_url(self, options)  
+          Transifex.query_api(:get, url)
+        end
+      end
+      def self.included(receiver)
+        receiver.send(:include, InstanceMethods)                 
+      end
+    end
+    module Create
+      module InstanceMethods
+        def create(params = {}, options = {})
+          missing_keys = self.class::CREATE_REQUIRED_PARAMS - params.keys
+          raise MissingParametersError.new(missing_keys) unless (missing_keys == [:repository_url] || missing_keys == [:private]) || missing_keys.empty?
+          if params[:repository_url] && !params[:repository_url].empty? && params[:repository_url].match(/^(http|https|ftp):\/\/[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+/).nil?
+            raise ParametersFormatError.new(:repository_url, "http|https|ftp://x.x.x") 
+          end
+          unless options[:trad_from_file].nil?
+            if params[:i18n_type] == "YAML"
+              params[:content] = YAML::load_file(params[:content]).to_yaml
+            else
+              file = File.open(params[:content], "rb")
+              params[:content] = file.read
+              file.close
+            end
+          end
+          url = CrudRequests.generate_url(self)
+          Transifex.query_api(:post, url, params)
+        end
+      end    
+       
+      def self.included(receiver)
+        receiver.send(:include, InstanceMethods)                 
+      end
+    end    
+    module Update
+      module InstanceMethods
+        def update(params = {}, options = {})      
+          if params.is_a?(Hash) && params[:i18n_type] && params[:i18n_type] != "TXT"
+            if params[:i18n_type] == "YML"
+              params[:content] = YAML::load_file(params[:content]).to_yaml
+            else
+              file = File.open(params[:content], "rb")
+              params[:content] = file.read
+              file.close
+            end
+            # Deal with accents
+            params[:content] = params[:content].force_encoding('UTF-8')
+          end              
+          url = CrudRequests.generate_url(self)
+          Transifex.query_api(:put, url, params)
+        end
+      end    
+       
+      def self.included(receiver)
+        receiver.send(:include, InstanceMethods)                 
+      end
+    end
+    module Delete
+      module InstanceMethods
+        def delete(params = {}, options = {})          
+          url = CrudRequests.generate_url(self)
+          Transifex.query_api(:delete, url, params)
+        end
+      end    
+       
+      def self.included(receiver)
+        receiver.send(:include, InstanceMethods)                 
+      end
+    end    
+  end  
+end

data/lib/transifex/errors.rb

@@ -0,0 +1,25 @@
+module Transifex
+  
+  class Error < StandardError
+  end
+
+  class MissingParametersError < Error
+    def initialize(*missing_attributes)
+      super("The following attributes are missing:" + missing_attributes.join(','))
+    end
+  end
+
+  class ParametersFormatError < Error
+    def initialize(parameter, format_expected)
+      super("The following parameter: " + parameter.to_s + " must follow the format: " + format_expected)
+    end
+  end
+  
+  class TransifexError < Error
+    attr_reader :request_url, :code, :details
+    def initialize(request_url, code, details)
+      @request_url, @code, @details = request_url, code, details
+      super(details) if details
+    end
+  end
+end

data/lib/transifex/formats.rb

@@ -0,0 +1,9 @@
+module Transifex
+  class Formats
+    include Transifex::CrudRequests::Fetch    
+
+    def self.fetch
+      Formats.new.fetch          
+    end 
+  end
+end

data/lib/transifex/json.rb

@@ -0,0 +1,23 @@
+module Transifex
+  module JSON
+    class << self
+      if MultiJson.respond_to?(:dump)
+        def dump(*args)
+          MultiJson.dump(*args)
+        end
+
+        def load(*args)
+          MultiJson.load(*args)
+        end
+      else
+        def dump(*args)
+          MultiJson.encode(*args)
+        end
+
+        def load(*args)
+          MultiJson.decode(*args)
+        end
+      end
+    end
+  end
+end

data/lib/transifex/language.rb

@@ -0,0 +1,13 @@
+module Transifex
+  class Language
+    include Transifex::CrudRequests::Fetch    
+
+    attr_accessor :language_slug
+
+    def initialize(language_code = nil)
+      raise MissingParametersError.new(["language_code"]) if language_code.nil?
+      @language_slug = language_code
+    end 
+        
+  end
+end

data/lib/transifex/languages.rb

@@ -0,0 +1,13 @@
+module Transifex
+  class Languages
+    include Transifex::CrudRequests::Fetch  
+
+    def self.fetch(language_code = nil)
+      if language_code.nil?
+        Languages.new.fetch
+      else
+        Transifex::Language.new(language_code).fetch
+      end                
+    end    
+  end
+end

data/lib/transifex/project.rb

@@ -0,0 +1,38 @@
+# Add a method add_resource to create a new resource for the project
+# Add a method get_resources to fetch all the resources
+
+module Transifex
+  class Project    
+    include Transifex::CrudRequests::Fetch
+    include Transifex::CrudRequests::Update
+    include Transifex::CrudRequests::Delete
+
+    attr_accessor :project_slug, :resources
+
+    def initialize(project_slug = nil)
+      raise MissingParametersError.new("You must provide a slug for a project") if project_slug.nil?
+      @project_slug = project_slug
+    end 
+
+    def resources
+      @resources ||= Transifex::Resources.new(@project_slug)
+    end
+
+    def resource(resource_slug)
+      Transifex::Resource.new(@project_slug, resource_slug)
+    end
+
+    def languages
+      Transifex::ProjectComponents::Languages.new(@project_slug)
+    end
+
+    def language(language_code)
+      Transifex::ProjectComponents::Language.new(@project_slug, language_code)
+    end
+
+    def fetch_with_details
+      options = {:details => true}
+      fetch(options)      
+    end
+  end
+end

data/lib/transifex/project_components/language.rb

@@ -0,0 +1,39 @@
+module Transifex
+  module ProjectComponents
+    class Language
+      include Transifex::CrudRequests::Fetch
+      include Transifex::CrudRequests::Update
+      include Transifex::CrudRequests::Delete
+
+      attr_accessor :project_slug, :language_slug
+
+      def initialize(project_slug = nil, language_code = nil)
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        raise MissingParametersError.new(["language_code"]) if language_code.nil?
+        @project_slug = project_slug
+        @language_slug = language_code
+      end
+
+      def self.parents
+        [:project]      
+      end
+
+      def fetch_with_details
+        options = {:details => true}
+        fetch(options)      
+      end
+
+      def coordinators
+        Transifex::ProjectComponents::LanguageComponents::Coordinators.new(@project_slug, @language_slug)
+      end
+
+      def reviewers
+        Transifex::ProjectComponents::LanguageComponents::Reviewers.new(@project_slug, @language_slug)
+      end
+
+      def translators
+        Transifex::ProjectComponents::LanguageComponents::Translators.new(@project_slug, @language_slug)
+      end
+    end
+  end
+end

data/lib/transifex/project_components/language_components/coordinators.rb

@@ -0,0 +1,29 @@
+module Transifex
+  module ProjectComponents
+    module LanguageComponents
+      class Coordinators
+        include Transifex::CrudRequests::Fetch
+        include Transifex::CrudRequests::Update
+
+        attr_accessor :project_slug, :language_slug
+
+        def initialize(project_slug = nil, language_code = nil)
+          raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+          raise MissingParametersError.new(["language_code"]) if language_code.nil?
+          @project_slug = project_slug
+          @language_slug = language_code
+        end
+
+        def self.parents
+          [:project, :language]
+        end
+
+        def update(coordinators_list = {}, options = {})
+          params = {}
+          params[:coordinators] = coordinators_list
+          super(params, options)
+        end
+      end
+    end
+  end
+end

data/lib/transifex/project_components/language_components/reviewers.rb

@@ -0,0 +1,33 @@
+module Transifex
+  module ProjectComponents
+    module LanguageComponents
+      class Reviewers
+        include Transifex::CrudRequests::Fetch
+        include Transifex::CrudRequests::Update
+
+        attr_accessor :project_slug, :language_slug
+
+        def initialize(project_slug = nil, language_code = nil)
+          raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+          raise MissingParametersError.new(["language_code"]) if language_code.nil?
+          @project_slug = project_slug
+          @language_slug = language_code
+        end
+
+        def self.parents
+          [:project, :language]
+        end
+
+        def update(reviewers_list = {}, options = {})
+          # Transifex needs coordinators list to be passed also when updating reviewers list. Strange
+          # Fetch the current coordinators list and add it to the params as a workaround.
+          fetched_language_infos = Transifex::Project.new(@project_slug).language(@language_slug).fetch
+          params = {}
+          params[:coordinators] = fetched_language_infos["coordinators"]          
+          params[:reviewers] = reviewers_list
+          super(params, options)
+        end
+      end
+    end
+  end
+end

data/lib/transifex/project_components/language_components/translators.rb

@@ -0,0 +1,33 @@
+module Transifex
+  module ProjectComponents
+    module LanguageComponents
+      class Translators
+        include Transifex::CrudRequests::Fetch
+        include Transifex::CrudRequests::Update
+
+        attr_accessor :project_slug, :language_slug
+
+        def initialize(project_slug = nil, language_code = nil)
+          raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+          raise MissingParametersError.new(["language_code"]) if language_code.nil?
+          @project_slug = project_slug
+          @language_slug = language_code
+        end
+
+        def self.parents
+          [:project, :language]
+        end
+              
+        def update(translators_list = {}, options = {})
+          # Transifex needs coordinators list to be passed also when updating reviewers list. Strange
+          # Fetch the current coordinators list and add it to the params as a workaround.
+          fetched_language_infos = Transifex::Project.new(@project_slug).language(@language_slug).fetch
+          params = {}
+          params[:coordinators] = fetched_language_infos["coordinators"]          
+          params[:translators] = translators_list
+          super(params, options)
+        end
+      end
+    end
+  end
+end