deepl-rb 0.0.0

data/lib/deepl/api.rb

@@ -0,0 +1,10 @@
+module DeepL
+  class API
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+      configuration.validate!
+    end
+  end
+end

data/lib/deepl/configuration.rb

@@ -0,0 +1,25 @@
+module DeepL
+  class Configuration
+    ATTRIBUTES = %i[auth_key host].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize(data = {})
+      data.each { |key, value| send("#{key}=", value) }
+      @auth_key ||= ENV['DEEPL_AUTH_KEY']
+      @host ||= 'https://api.deepl.com'
+    end
+
+    def validate!
+      raise Exceptions::Error, 'auth_key not provided' if auth_key.nil? || auth_key.empty?
+    end
+
+    def attributes
+      ATTRIBUTES.map { |attr| [attr, send(attr)] }.to_h
+    end
+
+    def ==(other)
+      attributes == other.attributes
+    end
+  end
+end

data/lib/deepl/exceptions/authorization_failed.rb

@@ -0,0 +1,9 @@
+module DeepL
+  module Exceptions
+    class AuthorizationFailed < RequestError
+      def message
+        'Authorization failed. Please supply a valid auth_key parameter.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/bad_request.rb

@@ -0,0 +1,9 @@
+module DeepL
+  module Exceptions
+    class BadRequest < RequestError
+      def message
+        JSON.parse(response.body)['message']
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/error.rb

@@ -0,0 +1,6 @@
+module DeepL
+  module Exceptions
+    class Error < StandardError
+    end
+  end
+end

data/lib/deepl/exceptions/limit_exceeded.rb

@@ -0,0 +1,9 @@
+module DeepL
+  module Exceptions
+    class LimitExceeded < RequestError
+      def message
+        'Limit exceeded. Please wait and send your request once again.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/request_error.rb

@@ -0,0 +1,16 @@
+module DeepL
+  module Exceptions
+    class RequestError < Error
+      attr_reader :request, :response
+
+      def initialize(request, response)
+        @request = request
+        @response = response
+      end
+
+      def message
+        'Unkown error.'
+      end
+    end
+  end
+end

data/lib/deepl/requests/base.rb

@@ -0,0 +1,72 @@
+module DeepL
+  module Requests
+    class Base
+      API_VERSION = 'v1'.freeze
+
+      attr_reader :api, :response
+
+      def initialize(api)
+        @api = api
+      end
+
+      def request
+        raise NotImplementedError
+      end
+
+      private
+
+      def post(payload)
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.set_form_data(payload.compact)
+        response = http.request(request)
+
+        validate_response!(request, response)
+        [request, response]
+      end
+
+      def http
+        @http ||= begin
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme == 'https'
+          http
+        end
+      end
+
+      def validate_response!(request, response)
+        return if response.is_a?(Net::HTTPSuccess)
+
+        case response.code
+        when '400' then raise Exceptions::BadRequest.new(request, response)
+        when '403' then raise Exceptions::AuthorizationFailed.new(request, response)
+        when '429' then raise Exceptions::LimitExceeded.new(request, response)
+        else raise Exceptions::RequestError.new(request, response)
+        end
+      end
+
+      def path
+        raise NotImplementedError
+      end
+
+      def url
+        "#{host}/#{API_VERSION}/#{path}"
+      end
+
+      def uri
+        @uri ||= begin
+          uri = URI(url)
+          new_query = URI.decode_www_form(uri.query || '') + query_params.to_a
+          uri.query = URI.encode_www_form(new_query)
+          uri
+        end
+      end
+
+      def host
+        api.configuration.host
+      end
+
+      def query_params
+        { auth_key: api.configuration.auth_key }
+      end
+    end
+  end
+end

data/lib/deepl/requests/translate_text.rb

@@ -0,0 +1,36 @@
+module DeepL
+  module Requests
+    class TranslateText < Base
+      attr_reader :text, :source_lang, :target_lang
+
+      def initialize(api, text, source_lang, target_lang)
+        super(api)
+        @text = text
+        @source_lang = source_lang
+        @target_lang = target_lang
+      end
+
+      def request
+        payload = { text: text, source_lang: source_lang, target_lang: target_lang }
+        build_texts(*post(payload))
+      end
+
+      private
+
+      def build_texts(request, response)
+        data = JSON.parse(response.body)
+
+        texts = data['translations'].map do |translation|
+          Resources::Text.new(translation['text'], translation['detected_source_language'],
+                              request, response)
+        end
+
+        texts.size == 1 ? texts.first : texts
+      end
+
+      def path
+        'translate'
+      end
+    end
+  end
+end

data/lib/deepl/resources/base.rb

@@ -0,0 +1,12 @@
+module DeepL
+  module Resources
+    class Base
+      attr_reader :request, :response
+
+      def initialize(request, response)
+        @request = request
+        @response = response
+      end
+    end
+  end
+end

data/lib/deepl/resources/text.rb

@@ -0,0 +1,18 @@
+module DeepL
+  module Resources
+    class Text < Base
+      attr_reader :text, :detected_source_language
+
+      def initialize(text, detected_source_language, *args)
+        super(*args)
+
+        @text = text
+        @detected_source_language = detected_source_language
+      end
+
+      def to_s
+        text
+      end
+    end
+  end
+end

data/spec/api/api_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe DeepL::API do
+  let(:configuration) { DeepL::Configuration.new }
+  subject { DeepL::API.new(configuration) }
+
+  describe '#initialize' do
+    context 'When building an API object' do
+      it 'should save the configuration' do
+        expect(subject.configuration).to be(configuration)
+      end
+    end
+  end
+end

data/spec/api/configuration_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe DeepL::Configuration do
+  let(:attributes) { {} }
+  subject { DeepL::Configuration.new(attributes) }
+
+  describe '#initialize' do
+    context 'When using default configuration attributes' do
+      it 'should use default attributes' do
+        expect(subject.auth_key).to eq(ENV['DEEPL_AUTH_KEY'])
+        expect(subject.host).to eq('https://api.deepl.com')
+      end
+    end
+
+    context 'When using custom configuration attributes' do
+      let(:attributes) { { auth_key: 'SAMPLE', host: 'http://www.example.org' } }
+
+      it 'should use custom attributes' do
+        expect(subject.auth_key).to eq(attributes[:auth_key])
+        expect(subject.host).to eq(attributes[:host])
+      end
+    end
+  end
+
+  describe '#validate!' do
+    let(:auth_message) { 'auth_key not provided' }
+
+    context 'When providing a valid auth key' do
+      let(:attributes) { { auth_key: '' } }
+
+      it 'should raise an error' do
+        expect { subject.validate! }.to raise_error(DeepL::Exceptions::Error, auth_message)
+      end
+    end
+
+    context 'When providing an invalid auth key' do
+      let(:attributes) { { auth_key: 'not-empty' } }
+
+      it 'should not raise an error' do
+        expect { subject.validate! }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/api/deepl_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe DeepL do
+  subject { DeepL.dup }
+
+  describe '#configure' do
+    context 'When providing no block' do
+      let(:configuration) { DeepL::Configuration.new }
+      before { subject.configure }
+
+      it 'should use default configuration' do
+        expect(subject.configuration).to eq(configuration)
+      end
+    end
+
+    context 'When providing a valid configuration' do
+      let(:configuration) do
+        DeepL::Configuration.new(auth_key: 'VALID', host: 'http://www.example.org')
+      end
+      before do
+        subject.configure do |config|
+          config.auth_key = configuration.auth_key
+          config.host = configuration.host
+        end
+      end
+
+      it 'should use the provided configuration' do
+        expect(subject.configuration).to eq(configuration)
+      end
+    end
+
+    context 'When providing an invalid configuration' do
+      it 'should raise an error' do
+        expect { subject.configure { |c| c.auth_key = '' } }
+          .to raise_error(DeepL::Exceptions::Error)
+      end
+    end
+  end
+
+  describe '#translate' do
+    let(:input) { 'Sample' }
+    let(:source_lang) { 'EN' }
+    let(:target_lang) { 'ES' }
+
+    around do |example|
+      VCR.use_cassette('deepl_translate') { example.call }
+    end
+
+    context 'When translating a text' do
+      it 'should create and call a request object' do
+        expect(DeepL::Requests::TranslateText).to receive(:new)
+          .with(subject.api, input, source_lang, target_lang).and_call_original
+
+        text = subject.translate(input, source_lang: source_lang, target_lang: target_lang)
+        expect(text).to be_a(DeepL::Resources::Text)
+      end
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/deepl_translate.yml

@@ -0,0 +1,110 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: source_lang=EN&target_lang=ES
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sun, 10 Dec 2017 21:20:25 GMT
+      Content-Length:
+      - '45'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Parameter ''text'' not specified."}'
+    http_version: 
+  recorded_at: Sun, 10 Dec 2017 21:20:25 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: text=Abc&source_lang=EN&target_lang=ES
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sun, 10 Dec 2017 21:21:23 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '65'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"ABC"}]}'
+    http_version: 
+  recorded_at: Sun, 10 Dec 2017 21:21:23 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: text=Sample&source_lang=EN&target_lang=ES
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sun, 10 Dec 2017 21:22:11 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '69'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
+    http_version: 
+  recorded_at: Sun, 10 Dec 2017 21:22:11 GMT
+recorded_with: VCR 4.0.0