phraseapp-in-context-editor-ruby 1.3.1 → 2.0.0

data/lib/phraseapp-in-context-editor-ruby/view_helpers.rb

@@ -1,35 +1,41 @@
-require 'json'
+require "json"
 
 module PhraseApp
   module InContextEditor
     module ViewHelpers
-      def phraseapp_in_context_editor_js(opts={})
+      def load_in_context_editor(opts = {})
         return "" unless PhraseApp::InContextEditor.enabled?
 
         # stringify to reduce possible errors when passing symbols
-        js_default_options = PhraseApp::InContextEditor.js_options.inject({}) { |conf, (k,v)| conf[k.to_s] = v; conf}
-        opts = opts.nil? ? {} : opts.inject({}) { |conf, (k,v)| conf[k.to_s] = v; conf}
+        opts = opts.nil? ? {} : opts.each_with_object({}) { |(k, v), conf|
+                                  conf[k.to_s] = v
+                                }
 
         # js options
         configuration = {
-          'projectId' => PhraseApp::InContextEditor.project_id,
-          'prefix' => PhraseApp::InContextEditor.prefix,
-          'suffix' => PhraseApp::InContextEditor.suffix,
-          'apiBaseUrl' => "#{PhraseApp::InContextEditor.api_host}/api/v2",
-        }.merge(js_default_options).merge(opts)
+          "projectId" => PhraseApp::InContextEditor.project_id,
+          "accountId" => PhraseApp::InContextEditor.account_id,
+          "datacenter" => PhraseApp::InContextEditor.datacenter,
+          "prefix" => PhraseApp::InContextEditor.prefix,
+          "suffix" => PhraseApp::InContextEditor.suffix
+        }.merge(opts)
 
-        snippet = <<-eos
-          <script>
-            window.PHRASEAPP_CONFIG = #{configuration.to_json};
-            (function() {
-              var phraseapp = document.createElement('script'); phraseapp.type = 'text/javascript'; phraseapp.async = true;
-              phraseapp.src = ['#{PhraseApp::InContextEditor.js_use_ssl ? 'https' : 'http'}://', '#{PhraseApp::InContextEditor.js_host}#{PhraseApp::InContextEditor.js_path}?', new Date().getTime()].join('');
-              var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(phraseapp, s);
-            })();
-          </script>
-        eos
+        snippet = <<-EOS
+        <script>
+          window.PHRASEAPP_CONFIG = #{configuration.to_json};
+          (function() {
+            let phraseapp = document.createElement('script');
+            phraseapp.type = 'module';
+            phraseapp.async = true;
+            phraseapp.src = "https://d2bgdldl6xit7z.cloudfront.net/latest/ice/index.js";
+            let script = document.getElementsByTagName('script')[0];
+            script.parentNode.insertBefore(phraseapp, script);
+          })();
+        </script>
+        EOS
         snippet.respond_to?(:html_safe) ? snippet.html_safe : snippet
       end
+      alias_method :phraseapp_in_context_editor_js, :load_in_context_editor
     end
   end
 end

data/lib/phraseapp-in-context-editor-ruby.rb

@@ -1,10 +1,8 @@
-# -*- encoding : utf-8 -*-
-require 'phraseapp-ruby'
-require 'request_store'
+require "request_store"
 
 module PhraseApp
   module InContextEditor
-    autoload :Config, 'phraseapp-in-context-editor-ruby/config'
+    autoload :Config, "phraseapp-in-context-editor-ruby/config"
 
     class << self
       def config
@@ -31,24 +29,12 @@ module PhraseApp
         config.project_id
       end
 
-      def access_token
-        config.access_token
+      def account_id
+        config.account_id
       end
 
-      def skip_ssl_verification
-        config.skip_ssl_verification
-      end
-
-      def cache_key_segments_initial
-        config.cache_key_segments_initial
-      end
-
-      def cache_lifetime
-        config.cache_lifetime
-      end
-
-      def ignored_keys
-        config.ignored_keys
+      def datacenter
+        config.datacenter
       end
 
       def enabled=(value)
@@ -62,38 +48,14 @@ module PhraseApp
       def disabled?
         !config.enabled
       end
-
-      def js_use_ssl
-        config.js_use_ssl
-      end
-
-      def js_host
-        config.js_host
-      end
-
-      def js_path
-        config.js_path
-      end
-
-      def js_options
-        config.js_options
-      end
-
-      def api_host
-        config.api_host
-      end
-
-      def api_client
-        config.api_client
-      end
     end
 
     def self.configure
       yield(PhraseApp::InContextEditor::Config)
     end
 
-    def self.with_config(config_options={}, &block)
-      original_config = self.config.dup
+    def self.with_config(config_options = {}, &block)
+      original_config = config.dup
       config.assign_values(config_options)
       yield
     ensure
@@ -101,17 +63,16 @@ module PhraseApp
     end
   end
 
-  autoload :ViewHelpers, 'phraseapp-in-context-editor-ruby/view_helpers'
+  autoload :ViewHelpers, "phraseapp-in-context-editor-ruby/view_helpers"
 
-  require 'phraseapp-in-context-editor-ruby/version'
-  require 'phraseapp-in-context-editor-ruby/engine'
-  require 'phraseapp-in-context-editor-ruby/delegate'
-  require 'phraseapp-in-context-editor-ruby/backend_service'
-  require 'phraseapp-in-context-editor-ruby/view_helpers'
+  require "phraseapp-in-context-editor-ruby/engine"
+  require "phraseapp-in-context-editor-ruby/delegate"
+  require "phraseapp-in-context-editor-ruby/backend_service"
+  require "phraseapp-in-context-editor-ruby/view_helpers"
 end
 
 # Only load adapters directly if non-rails app, otherwise use engine
 unless defined? Rails
-  require 'phraseapp-in-context-editor-ruby/adapters/i18n'
-  require 'phraseapp-in-context-editor-ruby/adapters/fast_gettext'
+  require "phraseapp-in-context-editor-ruby/adapters/i18n"
+  require "phraseapp-in-context-editor-ruby/adapters/fast_gettext"
 end

data/phraseapp-in-context-editor-ruby.gemspec

@@ -1,43 +1,28 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
-require 'phraseapp-in-context-editor-ruby/version'
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name = "phraseapp-in-context-editor-ruby"
-  s.version = PhraseApp::InContextEditor::VERSION
+  s.version = "2.0.0"
   s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.1'
-  s.authors = ["Dynport GmbH"]
+  s.required_ruby_version = ">= 3.2.0"
+  s.authors = ["Phrase"]
   s.email = ["info@phrase.com"]
   s.homepage = "https://phrase.com"
-  s.summary = %q{Translation management solution for web and mobile applications}
-  s.licenses = ['MIT']
-  s.description = %q{Phrase In-Context-Editor allows you to edit translations directly on the website. More information: phrase.com}
+  s.summary = "Translation management solution for web and mobile applications"
+  s.licenses = ["MIT"]
+  s.description = "Phrase In-Context-Editor allows you to edit translations directly on the website. More information: phrase.com"
   s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project = "phraseapp-in-context-editor-ruby"
-  git_files = `git ls-files | grep -v spec/`.split("\n") rescue ''
+  git_files = begin
+    `git ls-files | grep -v spec/`.split("\n")
+  rescue
+    ""
+  end
   s.files = git_files
-  s.test_files = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
-  if RUBY_VERSION >= '2.4'
-    s.add_dependency('json', '>= 1.8', '< 3')
-  else
-    s.add_dependency('json', '>= 1.7', '< 3')
-  end
-  s.add_dependency('i18n', '>= 0.6')
-  s.add_dependency('phraseapp-ruby', '~> 1.3')
-  s.add_dependency('request_store', '~> 1.3')
-  s.add_development_dependency('rspec', '~> 3.2')
-  s.add_development_dependency('webmock', '~> 1.21')
-  s.add_development_dependency('vcr', '~> 2.9')
-  s.add_development_dependency('timecop', '~> 0.7')
-  if RUBY_VERSION < '2.2'
-    s.add_development_dependency('mime-types', '< 3.0') # for 1.9.3 to work
-    s.add_development_dependency('rails', '~> 4.2')
-  else
-    s.add_development_dependency('rails', '>= 4.2', '< 5.1')
-  end
-  s.add_development_dependency('github_changelog_generator')
+  s.add_dependency("json", "~> 2.0")
+  s.add_dependency("i18n", "~> 1.0")
+  s.add_dependency("request_store", "~> 1.2")
+  s.add_development_dependency("rspec", "~> 3.0")
+  s.add_development_dependency("rails", "~> 7.0")
+  s.add_development_dependency("github_changelog_generator", "~> 1.16")
 end

metadata

@@ -1,167 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
-- Dynport GmbH
-autorequire: 
+- Phrase
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: phraseapp-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  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'
+        version: '1.16'
 description: 'Phrase In-Context-Editor allows you to edit translations directly on
   the website. More information: phrase.com'
 email:
@@ -170,41 +102,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".package-licenses.yml"
+- ".tool-versions"
 - CHANGELOG.md
+- CODEOWNERS
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- RELEASING.md
 - cacert.pem
+- config/license-decisions.yml
+- config/license_finder.yml
 - lib/generators/phraseapp_in_context_editor/install_generator.rb
-- lib/generators/phraseapp_in_context_editor/templates/README
 - lib/generators/phraseapp_in_context_editor/templates/phraseapp_in_context_editor.rb
 - lib/phraseapp-in-context-editor-ruby.rb
 - lib/phraseapp-in-context-editor-ruby/adapters/fast_gettext.rb
 - lib/phraseapp-in-context-editor-ruby/adapters/i18n.rb
-- lib/phraseapp-in-context-editor-ruby/api_collection.rb
-- lib/phraseapp-in-context-editor-ruby/api_wrapper.rb
 - lib/phraseapp-in-context-editor-ruby/backend_service.rb
-- lib/phraseapp-in-context-editor-ruby/cache.rb
 - lib/phraseapp-in-context-editor-ruby/config.rb
 - lib/phraseapp-in-context-editor-ruby/delegate.rb
 - lib/phraseapp-in-context-editor-ruby/delegate/fast_gettext.rb
 - lib/phraseapp-in-context-editor-ruby/delegate/i18n_delegate.rb
-- lib/phraseapp-in-context-editor-ruby/displayable_key_identifier.rb
 - lib/phraseapp-in-context-editor-ruby/engine.rb
-- lib/phraseapp-in-context-editor-ruby/fallback_keys_fetcher.rb
-- lib/phraseapp-in-context-editor-ruby/hash_flattener.rb
-- lib/phraseapp-in-context-editor-ruby/key_names_cache.rb
-- lib/phraseapp-in-context-editor-ruby/version.rb
 - lib/phraseapp-in-context-editor-ruby/view_helpers.rb
 - phraseapp-in-context-editor-ruby.gemspec
 homepage: https://phrase.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -212,16 +142,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: phraseapp-in-context-editor-ruby
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.4.13
+signing_key:
 specification_version: 4
 summary: Translation management solution for web and mobile applications
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - "2.1.10"
-  - "2.2.6"
-  - "2.3.3"
-  - "2.4.0"
-  - "2.5.1"
-script: bundle exec rspec spec

data/lib/generators/phraseapp_in_context_editor/templates/README

@@ -1,10 +0,0 @@
-===============================================================================
-Welcome to PhraseApp!
-
-PhraseApp is the translation management solution for web and mobile applications. Collaborate with your team, find professional translators and stay on top of the process.
-
-How awesome would it be if translators could simply browse your website and edit text along the way? Our In-Context Editor offers just that. It provides translators with useful contextual information which improves overall translation quality.
-
-Login: https://phraseapp.com/account/login
-Documentation: https://help.phraseapp.com/translate-website-and-app-content/use-in-context-editor-to-translate/translate-directly-on-your-website
-===============================================================================

data/lib/phraseapp-in-context-editor-ruby/api_collection.rb

@@ -1,41 +0,0 @@
-module PhraseApp
-  module InContextEditor
-    class ApiCollection
-      def initialize(api_client, action, ids=[], query=nil)
-        raise "PhraseApp API client can't handle action #{action}" unless api_client.respond_to?(action)
-
-        @api_client = api_client
-        @action = action
-        @ids = ids
-        @query = query
-      end
-
-      def collection
-        results = []
-        page = 1
-        per_page = 100
-        paginated, err = send_request(page, per_page)
-        results << paginated
-
-        while paginated.size == per_page
-          break if page > 100
-
-          page = page + 1
-          paginated, err = send_request(page, per_page)
-          results << paginated if paginated.present?
-        end
-
-        results.flatten.uniq
-      end
-
-    private
-      def send_request(page, per_page)
-        if @query.present?
-          @api_client.send(@action, *@ids, page, per_page, @query)
-        else
-          @api_client.send(@action, *@ids, page, per_page)
-        end
-      end
-    end
-  end
-end

data/lib/phraseapp-in-context-editor-ruby/api_wrapper.rb

@@ -1,59 +0,0 @@
-require 'phraseapp-in-context-editor-ruby/api_collection'
-
-module PhraseApp
-  module InContextEditor
-    class ApiWrapper
-      def initialize
-        @api_client = PhraseApp::InContextEditor.api_client
-      end
-
-      def default_locale
-        @default_locale ||= select_default_locale
-      end
-
-      def default_translation(key)
-        params = PhraseApp::RequestParams::TranslationsByKeyParams.new
-        translations = PhraseApp::InContextEditor::ApiCollection.new(@api_client, "translations_by_key", project_and_key_id(key), params).collection
-        return unless translations.present?
-
-        translations.select{ |translation| translation.locale["id"] == default_locale.id }
-      end
-
-      def keys_with_prefix(prefix)
-        params = PhraseApp::RequestParams::KeysSearchParams.new(q:"#{prefix}*")
-        keys_list(params)
-      end
-
-      def keys_by_names(names)
-        names = names.join(',')
-        params = PhraseApp::RequestParams::KeysSearchParams.new(:q => "name:#{names}")
-        keys_list(params)
-      end
-
-      def keys_list(params)
-        PhraseApp::InContextEditor::ApiCollection.new(@api_client, "keys_search", project_id, params).collection
-      end
-
-      def blacklisted_keys
-        PhraseApp::InContextEditor::ApiCollection.new(@api_client, "blacklisted_keys_list", project_id).collection.map{ |rule| rule.name }
-      end
-
-      private
-
-      def select_default_locale
-        locales = PhraseApp::InContextEditor::ApiCollection.new(@api_client, "locales_list", project_id).collection
-        return unless locales.present?
-
-        locales.select{ |loc| loc.default }.first
-      end
-
-      def project_id
-        [PhraseApp::InContextEditor.project_id]
-      end
-
-      def project_and_key_id(key)
-        project_id << key.id
-      end
-    end
-  end
-end

data/lib/phraseapp-in-context-editor-ruby/cache.rb

@@ -1,37 +0,0 @@
-# -*- encoding : utf-8 -*-
-
-require 'phraseapp-in-context-editor-ruby'
-
-module PhraseApp
-  module InContextEditor
-    class Cache
-      attr_accessor :lifetime
-
-      def initialize(args={})
-        @store = {}
-        @lifetime = args.fetch(:lifetime, PhraseApp::InContextEditor.cache_lifetime)
-      end
-
-      def cached?(cache_key)
-        @store.has_key?(cache_key) && !expired?(cache_key)
-      end
-
-      def get(cache_key)
-        begin
-          @store.fetch(cache_key)[:payload]
-        rescue
-          nil
-        end
-      end
-
-      def set(cache_key, value)
-        @store[cache_key] = {timestamp: Time.now, payload: value}
-      end
-
-    private
-      def expired?(cache_key)
-        @store.fetch(cache_key)[:timestamp] < (Time.now - @lifetime)
-      end
-    end
-  end
-end