deepl-rb 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 821de95f90b5bb4a436628dab27d4dbd4e7f12c1
+  data.tar.gz: 64ed5806cab9cc33ff66ea06af54726ceb7a6ace
+SHA512:
+  metadata.gz: e66573231bdb82961e72fa0ad620196f452dca86cbbc5405665b422f0df4549eef7ad3ad8fe572a0c0c4eebf071469fbe02b44c7cd49bc8edb7f452d620008d6
+  data.tar.gz: 76aca2cc48dd0544919775b79a8fdbe3c009664d54a0424e619ec5b27cdf65e9bc81889d2a60eb48ef177b7b2cfce60b5ca307ad119f35056f65b07e37e679cc

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/deepl-rb
+    docker:
+    - image: circleci/ruby:2.4-node
+    steps:
+    - checkout
+
+    # Restore bundle cache
+    - type: cache-restore
+      name: Restore bundle cache
+      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: Bundle Install
+        command: bundle install --path vendor/bundle
+
+    # Store bundle cache
+    - type: cache-save
+      name: Store bundle cache
+      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
+      paths:
+      - vendor/bundle
+
+    # Run rspec
+    - type: shell
+      command: |
+        bundle exec rspec $(circleci tests glob "spec/**/*_spec.rb" |
+                            circleci tests split --split-by=timings)
+
+    # Run rubocop
+    - type: shell
+      command: |
+        bundle exec rubocop
+
+    # Save test results for timing analysis
+    - store_test_results:
+        path: test_results

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# Custom rubocop configuration
+
+AllCops:
+  DisplayCopNames: true
+
+Metrics/BlockLength:
+  Exclude:
+  - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+group :development do
+  # Gem management
+  gem 'juwelier'
+end
+
+group :test do
+  # Test
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'simplecov'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,113 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.18.2)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashdiff (0.3.7)
+    hashie (3.5.6)
+    highline (1.7.10)
+    json (2.1.0)
+    juwelier (2.4.7)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (1.5.6)
+    kamelcase (0.0.1)
+      semver2 (~> 3)
+    mini_portile2 (2.3.0)
+    multi_json (1.12.2)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    psych (2.2.2)
+    public_suffix (3.0.1)
+    rack (2.0.3)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.0)
+    rdoc (5.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    semver2 (3.4.2)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    unicode-display_width (1.3.0)
+    vcr (4.0.0)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  juwelier
+  rspec
+  rubocop
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2018` `Daniel Herzog`
+
+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,102 @@
+[![Gem Version](https://badge.fury.io/rb/deepl-rb.svg)](https://badge.fury.io/rb/deepl-rb) [![Dependency Status](https://gemnasium.com/badges/github.com/wikiti/deepl-rb.svg)](https://gemnasium.com/github.com/wikiti/deepl-rb) [![CircleCI](https://circleci.com/gh/wikiti/deepl-rb.svg?style=shield)](https://circleci.com/gh/wikiti/deepl-rb)
+
+# DeepL for ruby
+
+A simple ruby wrapper for the [DeepL translation API (v1)](https://www.deepl.com/docs/api-reference.html).
+
+## Installation
+
+Install this gem with
+
+```sh
+gem install deepl-rb
+```
+
+Or add it to your Gemfile:
+
+```rb
+gem 'deepl-rb'
+```
+
+## Usage
+
+Setup an environment variable named `DEEPL_AUTH_KEY` with your authentication key:
+
+```sh
+export DEEPL_AUTH_KEY="your-api-token"
+```
+
+Alternatively, you can configure the API client within a ruby block:
+
+```rb
+DeepL.configure do |config|
+  config.auth_key = 'your-api-token'
+end
+```
+
+You can also configure the api host:
+
+```rb
+DeepL.configure do |config|
+  config.auth_key = 'your-api-token'
+  config.host = 'https://test-api.deepl.com' # Default value is 'https://api.deepl.com'
+end
+```
+
+### Translate
+
+To translate a simple text, use the `translate` method:
+
+```rb
+item = DeepL.translate 'This is my text', 'EN', 'ES'
+
+puts item.class
+# => DeepL::Resources::Text
+puts item.text
+# => 'Este es mi texto'
+```
+
+You can also auto-detect source language by skipping it with `nil`:
+
+```rb
+item = DeepL.translate 'This is my text', nil, 'ES'
+
+puts item.detected_source_language
+# => 'EN'
+```
+
+You can also translate a list of texts by passing an array as an argument:
+
+```rb
+texts = ['Sample text', 'Another text']
+items = DeepL.translate texts, 'EN', 'ES'
+
+puts items.class
+# => Array
+puts items.first.class
+# => DeepL::Resources::Text
+```
+
+## Development
+
+Clone the repository, and install its dependencies:
+
+```sh
+git clone https://github.com/wikiti/deepl-rb
+cd deepl-rb
+bundle install
+```
+
+To run tests (rspec and rubocop), use
+
+```
+bundle exec rake test
+```
+
+## Contributors
+
+This project has been developed by:
+
+| Avatar | Name | Nickname | Email |
+| ------ | ---- | -------- | ----- |
+| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [info@danielherzog.es](mailto:info@danielherzog.es)

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'juwelier'
+
+Juwelier::Tasks.new do |gem|
+  gem.name = 'deepl-rb'
+  gem.homepage = 'http://github.com/wikiti/deepl-rb'
+  gem.license = 'MIT'
+  gem.summary = 'A simple ruby wrapper for the DeepL API'
+  gem.description =
+    'A simple ruby wrapper for the DeepL translation API (v1). ' \
+    'For more information, check this: https://www.deepl.com/docs/api-reference.html'
+
+  gem.email = 'info@danielherzog.es'
+  gem.authors = ['Daniel Herzog']
+end
+
+Juwelier::RubygemsDotOrgTasks.new
+
+# Tests
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all tests.'
+task :test do
+  Rake::Task['spec'].invoke
+  Rake::Task['rubocop'].invoke
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/deepl-rb.gemspec

@@ -0,0 +1,69 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: deepl-rb 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "deepl-rb".freeze
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Daniel Herzog".freeze]
+  s.date = "2017-12-12"
+  s.description = "A simple ruby wrapper for the DeepL translation API (v1). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
+  s.email = "info@danielherzog.es".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    ".circleci/config.yml",
+    ".rubocop.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "deepl-rb.gemspec",
+    "lib/deepl.rb",
+    "lib/deepl/api.rb",
+    "lib/deepl/configuration.rb",
+    "lib/deepl/exceptions/authorization_failed.rb",
+    "lib/deepl/exceptions/bad_request.rb",
+    "lib/deepl/exceptions/error.rb",
+    "lib/deepl/exceptions/limit_exceeded.rb",
+    "lib/deepl/exceptions/request_error.rb",
+    "lib/deepl/requests/base.rb",
+    "lib/deepl/requests/translate_text.rb",
+    "lib/deepl/resources/base.rb",
+    "lib/deepl/resources/text.rb",
+    "spec/api/api_spec.rb",
+    "spec/api/configuration_spec.rb",
+    "spec/api/deepl_spec.rb",
+    "spec/fixtures/vcr_cassettes/deepl_translate.yml",
+    "spec/fixtures/vcr_cassettes/translate_texts.yml",
+    "spec/requests/translate_text_spec.rb",
+    "spec/resources/text_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/wikiti/deepl-rb".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.13".freeze
+  s.summary = "A simple ruby wrapper for the DeepL API".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+  end
+end
+

data/lib/deepl.rb

@@ -0,0 +1,56 @@
+# -- Dependencies
+require 'json'
+require 'net/http'
+
+# -- Exceptions
+require 'deepl/exceptions/error'
+require 'deepl/exceptions/request_error'
+require 'deepl/exceptions/authorization_failed'
+require 'deepl/exceptions/bad_request'
+require 'deepl/exceptions/limit_exceeded'
+
+# -- Requests
+require 'deepl/requests/base'
+require 'deepl/requests/translate_text'
+
+# -- Responses and resources
+require 'deepl/resources/base'
+require 'deepl/resources/text'
+
+# -- Other wrappers
+require 'deepl/api'
+require 'deepl/configuration'
+
+# -- Gem interface
+module DeepL
+  extend self
+
+  ## -- API shortcuts
+
+  def api
+    @api ||= API.new(configuration)
+  end
+
+  def translate(text, options = {})
+    configure if @configuration.nil?
+    Requests::TranslateText.new(api, text, fetch(options, :source_lang),
+                                fetch(options, :target_lang)).request
+  end
+
+  # -- Configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration if block_given?
+    configuration.validate!
+  end
+
+  private
+
+  def fetch(hash, key)
+    hash[key.to_s] || hash[key.to_sym]
+  end
+end