transifex-interface-ruby 0.0.1

data/lib/transifex/project_components/languages.rb

@@ -0,0 +1,21 @@
+module Transifex
+  module ProjectComponents
+    class Languages
+      include Transifex::CrudRequests::Fetch
+      include Transifex::CrudRequests::Create
+
+      CREATE_REQUIRED_PARAMS = [:language_code, :coordinators]
+
+      attr_accessor :project_slug
+
+      def initialize(project_slug = nil)
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        @project_slug = project_slug
+      end
+
+      def self.parents
+        [:project]      
+      end 
+    end    
+  end
+end

data/lib/transifex/projects.rb

@@ -0,0 +1,22 @@
+module Transifex
+  class Projects
+    include Transifex::CrudRequests::Fetch
+    include Transifex::CrudRequests::Create
+
+    CREATE_REQUIRED_PARAMS = [:slug, :name, :description, :source_language_code, :repository_url, :private]
+
+    def self.fetch
+      Transifex::Projects.new.fetch      
+    end
+
+    def fetch_with_details
+      options = {:details => true}
+      fetch(options)      
+    end
+
+    def self.create(params = {}, options = {})
+      Projects.new.create(params, options)
+      Transifex::Project.new(params[:slug])
+    end
+  end
+end

data/lib/transifex/resource.rb

@@ -0,0 +1,41 @@
+module Transifex
+  class Resource
+    include Transifex::CrudRequests::Fetch
+    include Transifex::CrudRequests::Update
+    include Transifex::CrudRequests::Delete
+
+    attr_accessor :project_slug, :resource_slug
+
+    def initialize(project_slug = nil, resource_slug = nil)
+      raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+      raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+      @project_slug = project_slug
+      @resource_slug = resource_slug
+    end
+
+    def self.parents
+      [:project]      
+    end  
+
+    def fetch_with_details
+      options = {:details => true}
+      self.fetch(options)      
+    end
+
+    def content
+      Transifex::ResourceComponents::Content.new(project_slug, resource_slug)
+    end
+
+    def statistics
+      Transifex::ResourceComponents::Stats.new(project_slug, resource_slug)
+    end
+
+    def translation(language_code = nil)      
+      Transifex::ResourceComponents::Translation.new(project_slug, resource_slug, language_code)
+    end
+
+    def source(key = nil, context = "")          
+      Transifex::ResourceComponents::Source.new(project_slug, resource_slug, key, context)
+    end
+  end
+end

data/lib/transifex/resource_components/content.rb

@@ -0,0 +1,54 @@
+module Transifex
+  module ResourceComponents
+    class Content
+      include Transifex::CrudRequests::Fetch
+      include Transifex::CrudRequests::Update
+
+      attr_accessor :project_slug, :resource_slug     
+
+      def initialize(project_slug, resource_slug)
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+        @project_slug = project_slug
+        @resource_slug = resource_slug
+      end
+      def self.parents
+        [:project, :resource]      
+      end
+      def fetch_with_file(path_to_file = nil)
+        raise MissingParametersError.new(["path_to_file"]) if path_to_file.nil?
+        options = {:file => true}
+        file_body = fetch(options)         
+        write_to_file(path_to_file, file_body)  
+      end     
+
+      def update(params = {}, options = {})
+        resource_i18n_type = Transifex::Resource.new(@project_slug, @resource_slug).fetch
+        raise Transifex::Error.new("You must use the mimetype #{resource_i18n_type["i18n_type"]} to upload a new resource file") if !check_i18n_type_concordance?(resource_i18n_type["i18n_type"], params[:i18n_type]) 
+        super
+      end
+
+      private 
+
+        def write_to_file(path_to_file, content)          
+          case File.extname(path_to_file)
+          when ".yml"
+            # Needed to correct carriage return problems when writing the Api response in the file
+            d = YAML::load(content)
+            File.open(path_to_file, "w") { |file| file.write d.to_yaml }    
+          else
+            File.open(path_to_file, "w") { |file| file.write content }
+          end          
+        end
+
+        def check_i18n_type_concordance?(resource_i18n_type, param)
+          case resource_i18n_type  
+          when "YML"            
+            param == "YML" || param == "YAML"
+          else
+            param == resource_i18n_type
+          end
+        end
+    end
+  end
+end

data/lib/transifex/resource_components/source.rb

@@ -0,0 +1,23 @@
+module Transifex
+  module ResourceComponents
+    class Source
+      include Transifex::CrudRequests::Fetch
+      include Transifex::CrudRequests::Update
+      include Transifex::ResourceComponents::TranslationComponents::Utilities 
+
+      attr_accessor :project_slug, :resource_slug, :source_slug     
+
+      def initialize(project_slug = nil, resource_slug = nil, translation_key = nil, translation_context = "")
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+        raise MissingParametersError.new(["translation_key"]) if translation_key.nil?
+        @project_slug = project_slug
+        @resource_slug = resource_slug
+        @source_slug = compute_source_entity_hash(translation_key, translation_context)
+      end
+      def self.parents
+        [:project, :resource]      
+      end
+    end
+  end
+end

data/lib/transifex/resource_components/stats.rb

@@ -0,0 +1,26 @@
+module Transifex
+  module ResourceComponents
+    class Stats
+      include Transifex::CrudRequests::Fetch
+
+      attr_accessor :project_slug, :resource_slug
+
+
+      def initialize(project_slug, resource_slug)
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+        @project_slug = project_slug
+        @resource_slug = resource_slug
+      end
+
+      def self.parents
+        [:project, :resource]      
+      end 
+
+      def fetch(language_code = nil)
+        instance_variable_set(:@stats_slug, language_code) unless language_code.nil?
+        super()
+      end
+    end
+  end
+end

data/lib/transifex/resource_components/translation.rb

@@ -0,0 +1,59 @@
+module Transifex
+  module ResourceComponents
+    class Translation
+      include Transifex::CrudRequests::Fetch
+      include Transifex::CrudRequests::Update
+
+      attr_accessor :project_slug, :resource_slug, :translation_slug
+
+      def initialize(project_slug = nil, resource_slug = nil, translation_slug = nil)
+        raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+        raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+        raise MissingParametersError.new(["translation_slug"]) if translation_slug.nil?
+        @project_slug = project_slug
+        @resource_slug = resource_slug
+        @translation_slug = translation_slug
+      end
+
+      def self.parents
+        [:project, :resource]      
+      end 
+
+      def fetch(options = {})
+        super
+      end
+
+      def fetch_with_file(options = {})
+        raise MissingParametersError.new(["path_to_file"]) if options[:path_to_file].nil?
+        path_to_file = options.delete(:path_to_file)
+        options[:file] = true
+        file_body = fetch(options)         
+        write_to_file(path_to_file, file_body)  
+      end 
+
+      def strings
+        Transifex::ResourceComponents::TranslationComponents::Strings.new(@project_slug, @resource_slug, @translation_slug)  
+      end
+
+      def string(key = nil , context = "")
+        raise MissingParametersError.new(["key"]) if key.nil?
+        raise MissingParametersError.new(["context"]) if context.nil?        
+        Transifex::ResourceComponents::TranslationComponents::String.new(@project_slug, @resource_slug, @translation_slug, key, context)  
+      end
+
+      private 
+
+        def write_to_file(path_to_file, content)          
+          case File.extname(path_to_file)
+          when ".yml"
+            # Needed to correct carriage return problems when writing the Api response in the file
+            d = YAML::load(content)
+            File.open(path_to_file, "w") { |file| file.write d.to_yaml }    
+          else
+            File.open(path_to_file, "w") { |file| file.write content }
+          end
+        end
+
+    end
+  end
+end

data/lib/transifex/resource_components/translation_components/string.rb

@@ -0,0 +1,29 @@
+module Transifex
+  module ResourceComponents
+    module TranslationComponents             
+      class String
+        include Transifex::CrudRequests::Fetch        
+        include Transifex::CrudRequests::Update        
+        include Utilities 
+
+        attr_accessor :project_slug, :resource_slug, :translation_slug, :string_slug
+
+        def initialize(project_slug = nil, resource_slug = nil, translation_slug = nil, translation_key = nil, translation_context = nil)
+          raise MissingParametersError.new(["translation_key"]) if translation_key.nil?
+          raise MissingParametersError.new(["translation_context"]) if translation_context.nil?
+          raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+          raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+          raise MissingParametersError.new(["translation_slug"]) if translation_slug.nil?
+          @project_slug = project_slug
+          @resource_slug = resource_slug
+          @translation_slug = translation_slug
+          @string_slug = compute_source_entity_hash(translation_key, translation_context)
+        end
+
+        def self.parents
+          [:project, :resource, :translation]            
+        end
+      end
+    end
+  end
+end

data/lib/transifex/resource_components/translation_components/strings.rb

@@ -0,0 +1,39 @@
+module Transifex
+  module ResourceComponents
+    module TranslationComponents             
+      class Strings 
+        include Transifex::CrudRequests::Fetch        
+        include Transifex::CrudRequests::Update  
+        include Utilities 
+        attr_accessor :project_slug, :resource_slug, :translation_slug
+
+        def initialize(project_slug = nil, resource_slug = nil, translation_slug = nil)
+          raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+          raise MissingParametersError.new(["resource_slug"]) if resource_slug.nil?
+          raise MissingParametersError.new(["translation_slug"]) if translation_slug.nil?
+          @project_slug = project_slug
+          @resource_slug = resource_slug
+          @translation_slug = translation_slug
+        end  
+
+        def fetch_with_details(options = {})
+          options[:details] = true
+          self.fetch(options)      
+        end
+
+        def self.parents
+          [:project, :resource, :translation]            
+        end  
+
+        def update(params)
+          params = [params] unless params.is_a?(Array)
+          params.each do |param|
+            raise MissingParametersError.new(["key"]) unless param.key?(:key)
+            param[:source_entity_hash] = compute_source_entity_hash(param[:key], param[:context])
+          end
+          super
+        end 
+      end
+    end
+  end
+end

data/lib/transifex/resource_components/translation_components/utilities.rb

@@ -0,0 +1,22 @@
+module Transifex
+  module ResourceComponents
+    module TranslationComponents
+      module Utilities
+        private
+          def compute_source_entity_hash(key, context = "")
+            keys = ''
+            if context.is_a?(Array)
+              unless context.empty?
+                keys = [key] + context
+              else
+                keys = [key, '']
+              end
+            else              
+              keys = [key, context]
+            end
+            Digest::MD5.hexdigest(keys.join(':').encode("UTF-8"))
+          end
+      end
+    end
+  end
+end

data/lib/transifex/resources.rb

@@ -0,0 +1,19 @@
+module Transifex
+  class Resources
+    include Transifex::CrudRequests::Fetch
+    include Transifex::CrudRequests::Create
+
+    CREATE_REQUIRED_PARAMS = [:slug, :name, :i18n_type, :content]
+
+    attr_accessor :project_slug
+
+    def initialize(project_slug = nil)
+      raise MissingParametersError.new(["project_slug"]) if project_slug.nil?
+      @project_slug = project_slug
+    end
+
+    def self.parents
+      [:project]      
+    end 
+  end
+end

data/lib/transifex/version.rb

@@ -0,0 +1,3 @@
+module Transifex
+  VERSION = "0.0.1"
+end

data/spec/lib/transifex/configuration_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Configuration do
+
+  it "should have the correct credentials" do
+    c = Transifex.configuration
+    expect(c.client_login).to eq('')
+    expect(c.client_secret).to eq('')
+  end
+
+  it "should not have incorrect credentials" do
+    c = Transifex.configuration
+    expect(c.client_login).not_to eq('')
+    expect(c.client_secret).not_to eq('')
+  end
+
+end

data/spec/lib/transifex/coordinators_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../../spec_helper'
+
+describe Transifex::ProjectComponents::LanguageComponents::Coordinators do
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ProjectComponents::LanguageComponents::Coordinators.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should not raise an error and retrieve the language's informations" do
+      language_coordinators_infos = nil
+      expect{ language_coordinators_infos = @project.language('en').coordinators.fetch }.to_not raise_error
+      expect(language_coordinators_infos).to be_a_kind_of(Hash)
+      expect(language_coordinators_infos.keys).to contain_exactly("coordinators")
+    end
+  end
+
+  describe "Update" do
+    it "should not raise an error and update the coordinators list" do
+      expect{ @project.language('en').coordinators.update(['fredericgrais'])}.to_not raise_error
+    end
+
+    it "should raise an error if the coordinator doesn't exist" do
+      expect{ @project.language('en').coordinators.update(['grgrgef'])}.to raise_error(Transifex::TransifexError)
+    end
+  end
+end

data/spec/lib/transifex/formats_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Formats do
+
+  describe "Fetch" do
+    it "should fetch all formats without raising an error" do
+      fetched_formats = nil
+      expect{ fetched_formats = Transifex::Formats.fetch }.to_not raise_error
+      expect(fetched_formats).to be_a_kind_of(Hash)
+      expect(fetched_formats.first[1].keys).to contain_exactly("mimetype", "file-extensions", "description")
+    end
+  end
+end

data/spec/lib/transifex/language_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Language do
+
+  describe "instanciation" do
+    it "should raise an error if a language code is not provided" do
+      expect { Transifex::Language.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end 
+
+  describe "Fetch" do
+    it "should fetch the selected language infos without raising an error" do
+      fetched_languages = nil
+      expect{ fetched_languages = Transifex::Languages.fetch('fr') }.to_not raise_error
+      expect(fetched_languages).to be_a_kind_of(Hash)
+      expect(fetched_languages.keys).to contain_exactly("rtl", "pluralequation", "code", "name", "nplurals")
+    end
+  end
+end