tolq-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 258c11a814c532f9b106b0be0006ffcfa938d896
-  data.tar.gz: 9f12adf9ad861511f37f4d4ae0e55f479c8374df
+  metadata.gz: 79808429da5819b754b3ace0836baff58d5ff9a3
+  data.tar.gz: 4708a7db5757288b8ccff4ab5d41132aa6da414c
 SHA512:
-  metadata.gz: 188798fb0b7a162b740b00910f16a16de378c9923e8e7c78be640c1a0ae21dbb7409c66890a858e41f97e3e98d84759dd73d6f6a716d33c21b05b33a7ca1c111
-  data.tar.gz: 0205cf15dee5659e58d5757514836a71fd770ae1c8b2831e6becbdbf571a937884bad09ffaf839ba65b5907f2aaa0a26ca9605a21eb8bd718cf376d9a0fd9873
+  metadata.gz: b68bfd086a1dacd994a203db2babf9f762057aa103e2f8a4898a41994f9413167794500c370feee08adc95bdc42ce8b5c174d66ad0248004aaeaadf613b18613
+  data.tar.gz: 947ec723d387be9512f1c48d65bd20bf2de23cc5e87843636771555e4c8a24fd80faeb115c1c859632f0bcaf831b8f7b37179e959bec01a3b0381234ae0fa5df

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.3.0
+* Added HMAC signature verification for callbacks

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    tolq-api (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.0)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  tolq-api!
+  webmock (~> 1.24.6)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -89,12 +89,14 @@ 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 = client.translation_requests.show(<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
 ```
+You can verify a callback HMAC signature by calling `client.valid_signature?`, this can be used to verify the authenticity of a callback.
+
+For more details on on the library please refer to the [gem documentation](http://www.rubydoc.info/gems/tolq-api). For more details on possible values see the [api documentation](https://docs.tolq.com).
 
-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
 

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
 end
 
 task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'pry'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/tolq-api.rb')
+
+pry

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.1

data/lib/tolq-api/client.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require 'net/https'
 
 module Tolq
   module Api
@@ -23,6 +23,17 @@ module Tolq
         TranslationRequestApi.new(self)
       end
 
+      # Verifies a signature on a callback payload
+      # You can find the signature in the X-Tolq-Signature
+      # header
+      #
+      # @param signature [String] A sha1 encoded HMAC signature including the 'sha1=' prefix
+      # @param payload [String] The body of the payload as a string
+      def valid_signature?(signature, payload)
+        payload_signature = 'sha1=' + OpenSSL::HMAC.digest('sha1', self.key, payload)
+        payload_signature == signature
+      end
+
       def get(path, data = nil)
         response = do_request(:get, path, data)
         handle_response(response)
@@ -67,7 +78,6 @@ module Tolq
           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'
 

data/lib/tolq-api/translation_request_api.rb

@@ -2,7 +2,7 @@ module Tolq
   module Api
     # Handles all requests dealing with translation requests
     class TranslationRequestApi
-      # Creats a new TranslationRequestApi.
+      # Creats a new Tolq::Api::ResponseApi.
       #
       # Called indirectly via Client#translation_requests
       #
@@ -15,7 +15,7 @@ module Tolq
       # 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
+      # @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata
       def create(request)
         @client.post('/translations/requests', request)
       end
@@ -23,7 +23,7 @@ module Tolq
       # 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
+      # @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata, if completed the translations are also included
       def show(id)
         @client.get("/translations/requests/#{id}")
       end
@@ -31,14 +31,14 @@ module Tolq
       # 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
+      # @return [Tolq::Api::Response] A Tolq::Api::Response 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
+      # @return [Tolq::Api::Response] A list of translation requests without translations
       def list
         @client.get('/translations/requests')
       end
@@ -46,7 +46,7 @@ module Tolq
       # Orders a translation request
       #
       # @param id [Integer] An id referencing a translation request
-      # @return [TranslationRequest] A TranslationRequest with an id, status and some metadata
+      # @return [Tolq::Api::Response] A Tolq::Api::Response with an id, status and some metadata
       def order(id)
         @client.post("/translations/requests/#{id}/order")
       end

data/lib/tolq-api/version.rb

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

data/tolq-api.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
 
   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.executables   = []
   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'
+  spec.add_development_dependency 'webmock', '~> 1.24.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolq-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Timon Vonk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.6
 description: A gem that wraps the Tolq.com API
 email:
 - timon@tolq.com
@@ -89,11 +89,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- circle.yml
 - lib/tolq-api.rb
 - lib/tolq-api/client.rb
 - lib/tolq-api/response.rb