voicearchive_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01e35e715a156914a65a201c6c54c4ecf11feb548fd91ecbd4c52df70821ec81
+  data.tar.gz: fa9402baecf70c3ffcaa8245d647601bc6ba39f8d193cfb7abbe0bbd2072dd61
+SHA512:
+  metadata.gz: 4673794d9f387bc015754263891f80013f9cffd0f0488c95bf6f8db90529ed15d1e5dda01d5aca5c0c959c08e207fb58870e6a9365b6960df76847e27a0ff226
+  data.tar.gz: 4f69a88d00c789c01ae5f849555480d0027916cb2ccd3e995e31edf5931d827c208533bce0bef2447e470116896841dd6a22f31bd5e83ff11c80031191d4a021

data/.exrc

@@ -0,0 +1,3 @@
+map <leader>gs :CommandTFlush<cr>\|:CommandT spec<cr>
+map <leader>gl :CommandTFlush<cr>\|:CommandT lib<cr>
+set wildignore+=coverage

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+> Why is this change proposed? How will it affect the code base? Which results are expected from the change? Include context, UI before/after screenshots, assumptions, knowledge, research, links, references, etc.
+
+---
+
+- [ ] This change is a [deliverable change](https://github.com/ArnsboMedia/playbook/tree/master/code-review#pull-requests), that can be deployed in isolation
+- [ ] Commits in this PR follow our [commit ruleset](https://github.com/ArnsboMedia/playbook/tree/master/code-review#commits) and guidelines
+- [ ] This PR follows our [styleguides](https://github.com/ArnsboMedia/playbook#code-style) & conventions
+
+> If any of the above are left blank, argue why..

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+env:
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Claus Witt
+
+MIT License
+
+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,34 @@
+# VoiceArchive Client Gem [![Build Status](https://travis-ci.com/ArnsboMedia/voicearchive_client.svg?branch=master)](https://travis-ci.com/ArnsboMedia/voicearchive_client)
+
+VoiceArchive API client gem, for use i Ruby projects. The projects implements some of the exposed API endpoint, from [Arnsbo Media Engine](https://github.com/ArnsboMedia/systemet).
+
+## Requirements
+
+- [Ruby](https://www.ruby-lang.org/en/news/2014/11/13/ruby-1-9-3-p551-is-released/) 1.9.3
+
+## Installation
+
+```shell
+$ scripts/setup
+```
+
+## Usage
+
+`scripts/server` will start an `irb` console, to play around with the Gem:
+
+```shell
+$ scripts/server
+```
+
+To use in an applicaiton, add this line to the Gemfile:
+
+```sh
+gem 'voicearchive_client', git: 'https://github.com/ArnsboMedia/voicearchive_client.git'
+```
+.. and then run `$ bundle` :rocket:
+
+## Test
+
+```shell
+$ scripts/test
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+class Rake::Task
+  def overwrite(&block)
+    @actions.clear
+    enhance(&block)
+  end
+end
+
+Rake::Task[:release].overwrite do
+  p "This task is bypassed on purpose, to ensure we do not accidentally push the gem to Rubygems"
+end
+

data/lib/voicearchive/client.rb

@@ -0,0 +1,78 @@
+require "active_support/core_ext/object/to_query"
+require "json"
+require "net/http"
+require "uri"
+require "openssl"
+
+module Voicearchive
+  class Client
+    attr_reader :api_key
+    attr_accessor :version
+
+    @@rest_path = 'rest'
+    @@auth_header = 'X-API-KEY'
+
+    def initialize(api_key = '', version = 1, host = 'https://system.voicearchive.com')
+      @api_key = api_key
+      @version = version
+      @host = host
+    end
+
+    def call(end_point, params={}, request_type="get")
+      url = get_url_object(end_point)
+      http = Net::HTTP.new url.host, url.port
+      http.read_timeout = 360
+      http.use_ssl = false
+      if url.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http.start do |http|
+        http.request(self.send("get_#{request_type.downcase}_request".to_sym,url, params))
+      end
+    end
+
+    def set_simple_endpoint_default_values(params)
+      if not params.key?(:pageSize)
+        params[:pageSize] = 10000000
+      end
+      params
+    end
+
+    private
+
+    def get_url_object(end_point)
+      URI.parse("#{@host}/#{@@rest_path}/v#{@version.to_s}/#{end_point}/")
+    end
+
+    def get_get_request(url, params={})
+      path = url.path.concat("?#{params.to_query}")
+      request = Net::HTTP::Get.new(path)
+      set_request_authentication(request)
+    end
+
+    def get_post_request(url, params={})
+      request = Net::HTTP::Post.new(url.path)
+      request.body = params.to_json
+      set_request_authentication(request)
+    end
+
+    def get_put_request(url, params={})
+      request = Net::HTTP::Put.new(url.path)
+      request.body = params.to_json
+      set_request_authentication(request)
+    end
+
+    def get_delete_request(url, params={})
+      request = Net::HTTP::Delete.new(url.path)
+      set_request_authentication(request)
+    end
+
+    def set_request_authentication(request)
+      request.add_field(@@auth_header, @api_key)
+      request
+    end
+
+  end
+end

data/lib/voicearchive/common_client.rb

@@ -0,0 +1,34 @@
+require 'voicearchive/client'
+
+module Voicearchive
+  class CommonClient < Client
+    attr_accessor :endpoint
+
+    def all(params = {})
+      params = set_simple_endpoint_default_values(params)
+      response = call("#{@endpoint}", params, 'get')
+      JSON.parse(response.body)
+    end
+
+    def find(id, params = {})
+      params = set_simple_endpoint_default_values(params)
+      response = call("#{@endpoint}/#{id}", params, 'get')
+      JSON.parse(response.body)
+    end
+
+    def create(params = {})
+      response = call(@endpoint, params, 'post')
+      JSON.parse(response.body)
+    end
+
+    def update(id, params = {})
+      response = call("#{@endpoint}/#{id}", params, 'put')
+      JSON.parse(response.body)
+    end
+
+    def destroy(id)
+      response = call("#{@endpoint}/#{id}", params, 'delete')
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/voicearchive/customer_client.rb

@@ -0,0 +1,32 @@
+require 'voicearchive/client'
+module Voicearchive
+  class CustomerClient < Client
+    def get_customers(params={})
+      params = set_simple_endpoint_default_values(params)
+      response = call('customer', params)
+      JSON.parse(response.body)
+    end
+    def get_customer(id, params={})
+      params = set_simple_endpoint_default_values(params)
+      response = call("customer/#{id}", params)
+      JSON.parse(response.body)
+    end
+    def update_customer(id, params = {})
+      response = call("customer/#{id}", params, "put")
+      JSON.parse(response.body)
+    end
+    def get_customer_contacts(id, params={})
+      params = set_simple_endpoint_default_values(params)
+      response = call("customer/#{id}/contacts", params)
+      JSON.parse(response.body)
+    end
+    def get_customer_contact(customer_id, contact_id, params={})
+      response = call("customer/#{customer_id}/contacts/#{contact_id}", params)
+      JSON.parse(response.body)
+    end
+    def update_customer_contact(customer_id, contact_id, params={})
+      response = call("customer/#{customer_id}/contacts/#{contact_id}", params, "put")
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/voicearchive/factory.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/string/inflections'
+module Voicearchive
+  class Factory
+    attr_reader :api_key
+    def initialize api_key
+      @api_key = api_key
+    end
+
+    def get_client name
+      name = name.to_s # allow symbols to be stringified
+      name = "#{name}_client" # suffix with client
+      require "voicearchive/#{name}" # require the file
+      constant_name = "Voicearchive::#{name.camelize}" # the constant name of the class (in the Voicearchive module)
+      constant_name.constantize.new(api_key) # return the new class, with the correct api_key
+    end
+  end
+end
+

data/lib/voicearchive/file_client.rb

@@ -0,0 +1,9 @@
+require 'voicearchive/client'
+module Voicearchive
+  class FileClient < Client
+    @@rest_path = ''
+    def get_approved_files(task_id)
+      call("/download/task/files/#{task_id}/approved")
+    end
+  end
+end

data/lib/voicearchive/order_client.rb

@@ -0,0 +1,74 @@
+require 'voicearchive/client'
+require 'voicearchive/task_client'
+
+module Voicearchive
+  class OrderClient < Client
+    def get_orders(params = {})
+      response = call("order", params)
+      JSON.parse(response.body)
+    end
+
+    def get_order(order_id, params = {})
+      response = call("order/#{order_id}", params)
+      JSON.parse(response.body)
+    end
+
+    def update_order(order_id, params = {})
+      response = call("order/#{order_id}", params, 'put')
+      JSON.parse(response.body)
+    end
+
+    def get_order_tasks(order_id, params = {})
+      response = call("order/#{order_id}/tasks", params)
+      JSON.parse(response.body)
+    end
+
+    def get_order_task(order_id, task_id, params = {})
+      response = call("order/#{order_id}/tasks/#{task_id}", params)
+      JSON.parse(response.body)
+    end
+
+    def update_order_task(order_id, task_id, params = {})
+      response = call("order/#{order_id}/tasks/#{task_id}", params, 'put')
+      JSON.parse(response.body)
+    end
+
+    def task_with_order(task_id, customer_id=false)
+      task = task_client.get_task(task_id)
+      order = get_order(task['orderid'].to_i)
+      if customer_id
+        if order['customer'].to_i != customer_id.to_i
+          raise 'Customer does not match'
+        end
+      end
+      task['order'] = order
+      task
+    end
+
+    def count_orders(options = {})
+      options[:count] = true
+      response = call('order', options, 'get')
+
+      json = JSON.parse(response.body)
+      return json unless json.key?('count')
+      json['count'].to_i
+    end
+
+    def get_products(order_id)
+      response = call("order/#{order_id}/products")
+      JSON.parse(response.body)
+    end
+
+    def get_services(order_id)
+      response = call("order/#{order_id}/services")
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def task_client
+      @task_client ||= TaskClient.new(@api_key)
+      @task_client
+    end
+  end
+end

data/lib/voicearchive/supplier_client.rb

@@ -0,0 +1,31 @@
+require 'voicearchive/client'
+module Voicearchive
+  class SupplierClient < Client
+    def get_supplier_search_options
+      response = call('supplier/form-schema')
+      JSON.parse(response.body)
+    end
+
+    def get_supplier_languages
+      response = call('supplier/languages')
+      JSON.parse(response.body)
+    end
+
+    def get_suppliers
+      response = call('supplier', {:includeRelations=>1})
+      JSON.parse(response.body)
+    end
+
+    def search_suppliers(params)
+      params[:includeRelations] = 1
+      response = call('supplier', params)
+      JSON.parse(response.body)
+    end
+
+    def get_supplier_demo_types()
+      params = set_simple_endpoint_default_values({})
+      response = call('supplierpromotype', params)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/voicearchive/task_client.rb

@@ -0,0 +1,50 @@
+require 'voicearchive/client'
+module Voicearchive
+  class TaskClient < Client
+    def set_supplier_on_task(task_id, supplier_id)
+      response = call("task/#{task_id}/SetSupplier", {:supplierId=>supplier_id}, 'put')
+      JSON.parse(response.body)
+    end
+
+    def set_task_data(task_id, supplier_id, comments, script)
+      response = call("task/#{task_id}/SetTaskData", {:supplierId=>supplier_id, :comments=>comments, :script=>script}, 'put')
+      JSON.parse(response.body)
+    end
+
+    def create_retake(task_id, reason_id, params = {})
+      response = call("task/#{task_id}/create-retake", params.merge({
+        reasonId: reason_id
+      }), 'put');
+
+      JSON.parse(response.body)
+    end
+
+    def get_task(task_id)
+      response = call("ordertask/#{task_id}")
+      JSON.parse(response.body)
+    end
+
+    def get_tasks(search_options, options)
+      response = call('ordertask', options.merge({
+        search: search_options,
+      }), 'get')
+
+      JSON.parse(response.body)
+    end
+
+    def search_tasks(search_options, options)
+      response = call('ordertask/search', options.merge({
+        search: search_options,
+      }), 'post')
+
+      JSON.parse(response.body)
+    end
+
+    def count_tasks(options = {})
+      options[:count] = true
+      response = call("task", options, 'get')
+
+      JSON.parse(response.body)["count"].to_i
+    end
+  end
+end