translation_io-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 490eaaf02161a2ee820ccd52cac7a6a1af4674c0b7c1543b4b7bfcc87fcb4995
+  data.tar.gz: 732d13e22a8ffc3d6a03225c053018f8f5a3b145ac47bbd46eb3c7a6ca9e6d8d
+SHA512:
+  metadata.gz: 790eaab0d2c75eaf1747ec90040f759e595902c33d1ababca0f543efeb568fcae908dd3d904d7aa598919e81d867a8062f0b557bfc25bab2591ec88c66953b24
+  data.tar.gz: 0b68db11434bc16a102ab7112a030605b621dde548331d064bb23f6c44969a97a50fc7717b2dc7ba0aa4181043f65d403a61dc8c1c71cbcc83c0093c203512ec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Rubocop caching file
+.rubocop-https*
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/lessonly/rubocop-default-configuration/master/.rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rreinhardt9@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in translation_io-api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ross Reinhardt
+
+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,111 @@
+# TranslationIO::API
+
+Wrapper for the translation.io rest API. This is a work in progress, we started with the endpoints we needed but expect that we can and contributers can continue to this base.
+Check out the [the documentation](https://translation.io/docs/api) for their API and the documentation on this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'translation_io-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install translation_io-api
+
+## Usage
+
+### List Segments
+
+```Ruby
+client = TranslationIO::API::Segments.new(api_key: "my-api-key")
+response = client.list("fr", tag: "needs review")
+
+response.code
+=> 200
+
+response.success?
+=> true
+
+response.body
+=> {
+  "segments": [
+    {
+      "id": 2,
+      "source_id": "b9d78193f955836a4ffd2ace3d06c725f605a8fdf142522908dc5605fce30f72",
+      "target_language": "fr",
+      "type": "source",
+      "source": "Good afternoon",
+      "target": "Bon après-midi",
+      "tags": [
+        "needs review"
+      ]
+    }
+  ]
+}
+
+```
+
+### Add a Tag
+
+```Ruby
+client = TranslationIO::API::Segments.new(api_key: "my-api-key")
+response = client.add_tag(1, name: "needs review")
+
+response.body
+=> {
+  "segment": {
+    "id": 1,
+    "source_id": "85af68954641ff0400756bc3b93de505680e621e834040a63732621e659c1d82",
+    "target_language": "fr",
+    "type": "source",
+    "source": "Hello",
+    "target": "Bonjour",
+    "tags": ["need review"]
+  }
+}
+```
+
+### Remove a Tag
+
+```Ruby
+client = TranslationIO::API::Segments.new(api_key: "my-api-key")
+response = client.remove_tag(1, name: "needs review")
+
+response.body
+=> {
+  "segment": {
+    "id": 1,
+    "source_id": "85af68954641ff0400756bc3b93de505680e621e834040a63732621e659c1d82",
+    "target_language": "fr",
+    "type": "source",
+    "source": "Hello",
+    "target": "Bonjour"
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rreinhardt9/translation_io-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rreinhardt9/translation_io-api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TranslationIO::API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rreinhardt9/translation_io-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "translation_io/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/translation_io/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "translation_io/api/version"
+require "translation_io/api/segments"
+require "translation_io/api/request"
+require "translation_io/api/response"
+
+module TranslationIO
+  module API
+    class Error < StandardError; end
+  end
+end

data/lib/translation_io/api/request.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module TranslationIO
+  module API
+    # An HTTP request
+    class Request
+      # Constructor
+      #
+      # @param api_key [String] translation.io api key
+      #
+      # @return [TranslationIO::API::Request]
+
+      def initialize(api_key:)
+        @api_key = api_key
+      end
+
+      # Get request
+      #
+      # @param uri [String]
+      # @param data [Hash] the JSON payload for this request
+      #
+      # @return [TranslationIO::API::Response]
+
+      def get(uri, data)
+        uri = URI.parse(uri)
+        req = Net::HTTP::Get.new(uri)
+
+        req["Content-Type"] = "application/json"
+        req["X-api-key"] = @api_key
+        req.body = data.to_json
+
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+
+        Response.new(res)
+      end
+
+      # Post request
+      #
+      # @param uri [String]
+      # @param data [Hash] the JSON payload for this request
+      #
+      # @return [TranslationIO::API::Response]
+
+      def post(uri, data)
+        uri = URI.parse(uri)
+        req = Net::HTTP::Post.new(uri)
+
+        req["Content-Type"] = "application/json"
+        req["X-api-key"] = @api_key
+        req.body = data.to_json
+
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+
+        Response.new(res)
+      end
+    end
+  end
+end

data/lib/translation_io/api/response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "json"
+
+module TranslationIO
+  module API
+    # Response represents a response from TranslationIO.
+    #
+    # It is returned when using methods in Request.
+    # @see TranslationIO::API::Request
+    class Response
+      attr_reader :raw_response
+
+      # Constructor
+      #
+      # @param response [Net::HTTPResponse] raw response from Net::HTTP
+      #
+      # @return [TranslationIO::API::Response
+
+      def initialize(response)
+        @raw_response = response
+      end
+
+      # Was the response code 2xx
+      #
+      # @return [Boolean]
+
+      def success?
+        @raw_response.is_a?(Net::HTTPSuccess)
+      end
+
+      # Integer representing the HTTP response code
+      #
+      # @return [Integer] HTTP response code
+
+      def code
+        Integer(@raw_response.code)
+      end
+
+      # Body of the response
+      #
+      # @return [Hash] response body
+
+      def body
+        return {} if @raw_response.body.strip.empty?
+
+        JSON.parse(@raw_response.body)
+      end
+    end
+  end
+end

data/lib/translation_io/api/segments.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module TranslationIO
+  module API
+    # Client for segment endpoints
+    class Segments
+      def initialize(api_key:)
+        @api_key = api_key
+        @base_url = "https://translation.io/api/v1/segments"
+      end
+
+      # List segments for target language
+      #
+      # @param target_language [String] Target language code (from
+      #   https://translation.io/docs/languages). Example: "es"
+      # @param options [Hash] optional params to pass with the call to list
+      # @option options [String] :query Query segments to returns only the
+      #   ones that contain query value in their key, source, target (with
+      #   plurals), context, comment or references properties.
+      #   Note: that query is case-insensitive.
+      # @option options [String] :type ("all") Filter by type of segments.
+      #   Should be key, source or all.
+      # @option options [String] :state ("all") Filter by state of segments.
+      #   Should be translated, untranslated or all.
+      # @option options [String] :tag Filter by tag. Only returns segments
+      #   that are tagged with tag value.
+      #
+      # @return [TranslationIO::API::Response] response
+
+      def list(target_language, options = {})
+        request.get(
+          @base_url,
+          options.merge("target_language": target_language)
+        )
+      end
+
+      # Create a segment
+      #
+      # @param target_language [String] Target language code (from
+      #   https://translation.io/docs/languages). Example: "es"
+      # @param type [String] Segment type. Should be "key" or "source".
+      # @param key [String] Key associated with the text to be translated.
+      #   Only for "key" type. Example: "home.call_to_action.bottom"
+      # @param source [String] Source text.  Example: "Click here to subscribe"
+      #
+      # @return [TranslationIO::API::Response] response containing created
+      #   segment.
+
+      def create(target_language, type:, key:, source:)
+        request.post(
+          @base_url, {
+            target_language: target_language,
+            type: type,
+            key: key,
+            source: source
+          }
+        )
+      end
+
+      # Add a tag to a segment
+      #
+      # @param segment_id [String, Integer] The ID of the segment
+      # @param name [String] The name of the tag to add
+      #
+      # @note a unique color will be attributed to the tag. If this tag
+      #   already exists in the project, the same color will be reused.
+      # @note if this tag is already added to the segment, nothing will change
+      #   and no error will be triggered.
+      #
+      # @return [TranslationIO::API::Response] response containing updated
+      #   segment
+
+      def add_tag(segment_id, name:)
+        request.post(@base_url + "/#{segment_id}/add_tag", { name: name })
+      end
+
+      # Remove a tag from a segment
+      #
+      # @param segment_id [String, Integer] The ID of the segment
+      # @param name [String] The name of the tag to remove
+      #
+      # @note if this tag doesn't exist or is not linked to this segment,
+      #   nothing will change and no error will be triggered.
+      #
+      # @return [TranslationIO::API::Response] response containing updated
+      #   segment
+
+      def remove_tag(segment_id, name:)
+        request.post(@base_url + "/#{segment_id}/remove_tag", { name: name })
+      end
+
+      private
+
+      def request
+        Request.new(api_key: @api_key)
+      end
+    end
+  end
+end

data/lib/translation_io/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TranslationIO
+  module API
+    VERSION = "0.1.0"
+  end
+end

data/translation_io-api.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/translation_io/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "translation_io-api"
+  spec.version       = TranslationIO::API::VERSION
+  spec.authors       = ["Ross Reinhardt"]
+  spec.email         = ["rreinhardt9@gmail.com"]
+
+  spec.summary       = %q{Client for translation.io REST API}
+  spec.homepage      = "https://github.com/rreinhardt9/translation_io-api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/rreinhardt9/translation_io-api/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: translation_io-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ross Reinhardt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: 
+email:
+- rreinhardt9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/translation_io/api.rb
+- lib/translation_io/api/request.rb
+- lib/translation_io/api/response.rb
+- lib/translation_io/api/segments.rb
+- lib/translation_io/api/version.rb
+- translation_io-api.gemspec
+homepage: https://github.com/rreinhardt9/translation_io-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rreinhardt9/translation_io-api
+  source_code_uri: https://github.com/rreinhardt9/translation_io-api
+  changelog_uri: https://github.com/rreinhardt9/translation_io-api/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Client for translation.io REST API
+test_files: []