tolq-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 258c11a814c532f9b106b0be0006ffcfa938d896
+  data.tar.gz: 9f12adf9ad861511f37f4d4ae0e55f479c8374df
+SHA512:
+  metadata.gz: 188798fb0b7a162b740b00910f16a16de378c9923e8e7c78be640c1a0ae21dbb7409c66890a858e41f97e3e98d84759dd73d6f6a716d33c21b05b33a7ca1c111
+  data.tar.gz: 0205cf15dee5659e58d5757514836a71fd770ae1c8b2831e6becbdbf571a937884bad09ffaf839ba65b5907f2aaa0a26ca9605a21eb8bd718cf376d9a0fd9873

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at timonv@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tolq-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Timon Vonk
+
+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 @@
+# Tolq::Api
+
+The Tolq Api gem wraps our api, making it a lot easier to integrate it with your Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tolq-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tolq-api
+
+## Usage
+
+For an overview of how our api works, see [the documentation](http://docs.tolq.com/docs/api-getting-started).
+
+First, you need to create a a client.
+
+```ruby
+client = Tolq::Api::Client.new(ENV['TOLQAPIKEY'], ENV['TOLQAPISECRET'])
+```
+
+_Before making any translation requests, make sure you have set up your billing information
+correctly._
+
+
+You can directly create and order a translation request:
+
+```ruby
+response = client.translation_requests.create(
+    "request" => {
+        "a.key" => {
+            "text" => "A sentence to translate"
+        }
+    },
+    "source_language_code" => "en",
+    "target_language_code" => "nl",
+    "quality" => "standard",
+    "options" => {
+        "name" => "My translation request",
+        "callback_url" => "https://mysite.com/translations_finished"
+    }
+
+)
+
+response.class # Tolq::Api::Response
+response.body # A tolq response as per the documentation. This JSON and can be parsed using your favourite json parser
+```
+
+When present, Tolq will make a callback to the callback url when the translations have been fully finished.
+
+You can also create a quote, these will not be ordered directly and need your confirmation.
+
+```ruby
+response = client.translation_requests.quote(
+    "request" => {
+        "a.key" => {
+            "text" => "A sentence to translate"
+        }
+    },
+    "source_language_code" => "en",
+    "target_language_code" => "nl",
+    "quality" => "standard",
+    "options" => {
+        "name" => "My translation request",
+        "callback_url" => "https://mysite.com/translations_finished"
+    }
+
+)
+
+response.class # Tolq::Api::Response
+response.body # A tolq response as per the documentation. This JSON and can be parsed using your favourite json parser
+```
+
+After creating the quote, you can order it:
+
+```ruby
+client.translation_request.order(response.id)
+```
+
+If you do not have a callback url or are just interested in the status, you can request the status and/or translations as follows:
+
+```ruby
+response = client.show_translation_request(<id>)
+response.class # Tolq::Api::Response
+response.body # A tolq response as per the documentation. This JSON and can be parsed using your favourite json parser
+```
+
+For more details on on the library please refer to the [gem documentation](TODO). For more details on possible values see the [api documentation](https://docs.tolq.com).
+
+## Development
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tolq-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/lib/tolq-api.rb

@@ -0,0 +1,9 @@
+require 'tolq-api/version'
+
+Dir[File.dirname(__FILE__) + '/tolq-api/*.rb'].each { |file| require file }
+
+module Tolq
+  module Api
+    # Your code goes here...
+  end
+end

data/lib/tolq-api/client.rb

@@ -0,0 +1,82 @@
+require 'net/http'
+
+module Tolq
+  module Api
+    # Client handles and encapsulates API requests
+    class Client
+      BASE_URL = 'https://%{key}:%{secret}@api.tolq.com/v1'.freeze
+      attr_reader :key, :secret
+
+      # Creates a client to interface with the Tolq API.
+      #
+      # @param key [String] Your API key
+      # @param secret [String] Your API secret
+      def initialize(key, secret)
+        @key = key
+        @secret = secret
+      end
+
+      # Via this method you can make requests to the Tolq API
+      #
+      # @return [TranslationRequestApi] An interface for making api requests.
+      def translation_requests
+        TranslationRequestApi.new(self)
+      end
+
+      def get(path, data = nil)
+        response = do_request(:get, path, data)
+        handle_response(response)
+      end
+
+      def post(path, data = nil)
+        response = do_request(:post, path, data)
+        handle_response(response)
+      end
+
+      def delete(path, data = nil)
+        response = do_request(:delete, path, data)
+        handle_response(response)
+      end
+
+      def put(path, data = nil)
+        response = do_request(:put, path, data)
+        handle_response(response)
+      end
+
+      private
+
+      def base_url
+        # TODO remove interpolation
+        # not needed with Net::HTTP
+        BASE_URL % { key: key, secret: secret }
+      end
+
+      def do_request(method, path, data = nil)
+        uri = URI.parse(base_url + path)
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+
+        request =
+          case method
+          when :post
+            Net::HTTP::Post.new(uri.path)
+          when :get
+            Net::HTTP::Get.new(uri.path)
+          when :delete
+            Net::HTTP::Delete.new(uri.path)
+          end
+
+        request.body = data.to_json if data
+        # TODO Probably also need to use tls and verify peer for ssl
+        request.basic_auth @key, @secret
+        request['Content-Type'] = 'application/json'
+
+        https.request(request)
+      end
+
+      def handle_response(response)
+        Response.new(status: response.code.to_i, body: response.body)
+      end
+    end
+  end
+end

data/lib/tolq-api/response.rb

@@ -0,0 +1,19 @@
+module Tolq
+  module Api
+    # Wraps the responses of the Tolq Api
+    class Response
+      attr_reader :status, :body
+
+      def initialize(status:, body:)
+        raise ArgumentError.new('Expected body to be a string') unless !body || body.is_a?(String)
+
+        @status = status.to_i
+        @body = body
+      end
+
+      def ==(other)
+        self.status == other.status && self.body == other.body
+      end
+    end
+  end
+end

data/lib/tolq-api/translation_request_api.rb

@@ -0,0 +1,63 @@
+module Tolq
+  module Api
+    # Handles all requests dealing with translation requests
+    class TranslationRequestApi
+      # Creats a new TranslationRequestApi.
+      #
+      # Called indirectly via Client#translation_requests
+      #
+      # You should check the 'errors' method on the translation request.
+      # Our API returns helpful validation errors if there are any.
+      def initialize(client)
+        @client = client
+      end
+
+      # Creates and orders a new translation request
+      #
+      # @param request [Hash] A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details
+      # @return [TranslationRequest] A TranslationRequest with an id, status and some metadata
+      def create(request)
+        @client.post('/translations/requests', request)
+      end
+
+      # Retrieves a translation request
+      #
+      # @param id [Integer] An id referencing a translation request
+      # @return [TranslationRequest] A TranslationRequest with an id, status and some metadata, if completed the translations are also included
+      def show(id)
+        @client.get("/translations/requests/#{id}")
+      end
+
+      # Creates but doesn't order a new translation request
+      #
+      # @param request [Hash] A hash consisting of a translation request, this maps 1:1 with the JSON request format. See our documentation for details
+      # @return [TranslationRequest] A TranslationRequest with an id, status and some metadata
+      def quote(request)
+        @client.post('/translations/requests/quote', request)
+      end
+
+      # Lists all your translation requests
+      #
+      # @return [Array<TranslationRequest>] A list of translation requests without translations
+      def list
+        @client.get('/translations/requests')
+      end
+
+      # Orders a translation request
+      #
+      # @param id [Integer] An id referencing a translation request
+      # @return [TranslationRequest] A TranslationRequest with an id, status and some metadata
+      def order(id)
+        @client.post("/translations/requests/#{id}/order")
+      end
+
+      # Deletes a translation request
+      #
+      # @param id [Integer] An id referencing a translation request
+      # @return [true,false] A boolean indicating success
+      def delete(id)
+        @client.delete("/translations/requests/#{id}")
+      end
+    end
+  end
+end

data/lib/tolq-api/version.rb

@@ -0,0 +1,5 @@
+module Tolq
+  module Api
+    VERSION = '0.2.0'.freeze
+  end
+end

data/tolq-api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tolq-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tolq-api'
+  spec.version       = Tolq::Api::VERSION
+  spec.authors       = ['Timon Vonk']
+  spec.email         = ['timon@tolq.com']
+
+  spec.summary       = 'A gem that wraps the Tolq.com API'
+  spec.description   = 'A gem that wraps the Tolq.com API'
+  spec.homepage      = "https://www.github.com/tolq/tolq-api-ruby"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: tolq-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Timon Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A gem that wraps the Tolq.com API
+email:
+- timon@tolq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tolq-api.rb
+- lib/tolq-api/client.rb
+- lib/tolq-api/response.rb
+- lib/tolq-api/translation_request_api.rb
+- lib/tolq-api/version.rb
+- tolq-api.gemspec
+homepage: https://www.github.com/tolq/tolq-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem that wraps the Tolq.com API
+test_files: []
+has_rdoc: