onesky-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07702d69f7f7c3651594e79cf6dbd6e3bdf35205
+  data.tar.gz: f4bfd6c6a08a1b2ad6747d317bd676bd175989e7
+SHA512:
+  metadata.gz: 6f995fba3cc6aa9486a467474ed9b041fb4132a1222c3a787699ed0da7a718aa74e6bb1d8a3aa4869036a8cfbc0c47579dcdb9327a11351cdb7f4abcab1bdffa
+  data.tar.gz: 182b75526c85377c628084bf88920d605aff30af196e90fd1514b89c5835e531a6f5f4f4bb18f41022933b34e0d7e1162a3ca8180eaed6b42f1e41f8ed9b296b

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 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Victor Lam
+
+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,67 @@
+# OneSky - Ruby client
+
+Ruby client for [OneSky](http://www.oneskyapp.com) [Platform API](/onesky/api-documentation-platform)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onesky-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onesky-ruby
+
+## Usage
+
+```Ruby
+require 'onesky'
+
+# Create client
+client = Onesky::Client.new('<api_key>', '<api_secret>')
+
+# list available locales
+resp = JSON.parse(client.list_locale)
+p resp['data']
+
+# list project groups
+resp = JSON.parse(client.list_project_group)
+p resp['data']
+
+# show project group details
+project_group_id = 1
+resp = JSON.parse(client.show_project_group project_group_id)
+p resp['data']
+
+# list projects
+resp = JSON.parse(client.list_project project_group_id)
+p resp['data']
+
+### Work with Project
+
+# show project details
+project_id = 3
+project = client.porject(project_id)
+resp = JSON.parse(project.show)
+p resp['data']
+
+# upload file
+resp = project.upload_file(file: 'path/to/string/file', file_format: 'RUBY_YAML')
+resp.code # => 201
+
+# download translation
+resp = project.export_translation(source_file_name: 'en.yml', locale: 'ja')
+File.open('path/to/target/file', 'w') { |file| file.write(resp)}
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/onesky-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/onesky/client.rb

@@ -0,0 +1,36 @@
+require 'digest'
+
+require 'onesky/resources/locale'
+require 'onesky/resources/project_type'
+require 'onesky/resources/project_group'
+require 'onesky/resources/project'
+require 'onesky/helpers/request'
+require 'onesky/project'
+
+module Onesky
+  class Client
+    include Resources::Locale
+    include Resources::ProjectType
+    include Resources::ProjectGroup
+    include Resources::Project
+    include Helpers::Request
+
+    attr_accessor :api_key, :api_secret, :project_id
+
+    def initialize(key, secret)
+      @api_key = key
+      @api_secret = secret
+    end
+
+    def auth_hash
+      now = Time.now.to_i
+
+      {
+        api_key: @api_key,
+        timestamp: now,
+        dev_hash: Digest::MD5.hexdigest(now.to_s + @api_secret)
+      }
+    end
+
+  end
+end

data/lib/onesky/errors.rb

@@ -0,0 +1,30 @@
+module Onesky
+  module Errors
+
+    class OneskyError < StandardError
+      attr_accessor :response
+      def initialize(resp)
+        @response = resp
+      end
+    end
+
+    # Raise error of 400 Bad Request
+    class BadRequestError       < OneskyError; end
+
+    # Raise error of 401 Unauthorized
+    class UnauthorizedError     < OneskyError; end
+
+    # Raise error of 403 Forbidden
+    class ForbiddenError        < OneskyError; end
+
+    # Raise error of 404 Not Found
+    class NotFoundError         < OneskyError; end
+
+    # Raise error of 405 Method Not Allowed
+    class MethodNotAllowedError < OneskyError; end
+
+    # Raise error of 500 Internal Server Error
+    class InternalServerError   < OneskyError; end
+
+  end
+end

data/lib/onesky/helpers/request.rb

@@ -0,0 +1,82 @@
+require 'rest-client'
+
+module Helpers
+  module Request
+
+    ENDPOINT = 'https://platform.api.onesky.io'
+    VERSION = 1
+
+    protected
+
+    def get(path, params = {})
+      uri = uri_prefix + path
+      RestClient.get(uri, params: auth_hash.merge(params)) do |resp, req, result|
+        handle_error(resp)
+      end
+    end
+
+    def post(path, body_hash)
+      uri = uri_prefix + path
+      RestClient.post(uri, body_hash.to_json, content_type: :json, params: auth_hash) do |resp, req, result|
+        handle_error(resp)
+      end
+    end
+
+    def post_multipart(path, body_hash)
+      uri = uri_prefix + path
+      RestClient.post(uri, body_hash.merge({multipart: true}), params: auth_hash) do |resp, req, result|
+        handle_error(resp)
+      end
+    end
+
+    def put(path, body_hash)
+      uri = uri_prefix + path
+      RestClient.put(uri, body_hash.to_json, content_type: :json, params: auth_hash) do |resp, req, result|
+        handle_error(resp)
+      end
+    end
+
+    def delete(path, params = {})
+      uri = uri_prefix + path
+      RestClient.delete(uri, params: auth_hash.merge(params)) do |resp, req, result|
+        handle_error(resp)
+      end
+    end
+
+    private
+
+    def uri_prefix
+      "#{ENDPOINT}/#{VERSION}"
+    end
+
+    def handle_error(response)
+      return response if response.code.to_i < 400 # return if not error
+
+      case response.code.to_i
+      when 400
+        raise Onesky::Errors::BadRequestError.new(response), "400 Bad Request - #{extract_message(response)}"
+      when 401
+        raise Onesky::Errors::UnauthorizedError.new(response), "401 Unauthorized - #{extract_message(response)}"
+      when 403
+        raise Onesky::Errors::ForbiddenError.new(response), "403 Forbidden - #{extract_message(response)}"
+      when 404
+        raise Onesky::Errors::NotFoundError.new(response), "404 Not Found - #{extract_message(response)}"
+      when 405
+        raise Onesky::Errors::MethodNotAllowedError.new(response), "405 Method Not Allowed - #{extract_message(response)}"
+      when 500
+        raise Onesky::Errors::InternalServerError.new(response), "500 Internal Server Error - Please contact OneSky at support@oneskyapp.com"
+      else
+        raise Onesky::Errors::OneskyError.new(response), "#{response.code} Error"
+      end
+    end
+
+    def extract_message(response)
+      response_body = JSON.parse(response)
+      if response_body.has_key?('meta') && response_body['meta'].has_key?('message')
+        return response_body['meta']['message']
+      end
+      ''
+    end
+
+  end
+end

data/lib/onesky/project.rb

@@ -0,0 +1,38 @@
+require 'onesky/resources/project/base'
+require 'onesky/resources/project/file_mgt'
+require 'onesky/resources/project/translation'
+require 'onesky/resources/project/import_task'
+require 'onesky/resources/project/quotation'
+require 'onesky/resources/project/order'
+require 'onesky/helpers/request'
+
+module Onesky
+  class Project
+
+    include Resources::Project::Base
+    include Resources::Project::FileMgt
+    include Resources::Project::Translation
+    include Resources::Project::ImportTask
+    include Resources::Project::Quotation
+    include Resources::Project::Order
+    include Helpers::Request
+
+    attr_accessor :client, :project_id
+
+    def initialize(client, id)
+      @client = client
+      @project_id = id
+    end
+
+    private
+
+    def project_path
+      "/projects/#{@project_id}"
+    end
+
+    def auth_hash
+      @client.auth_hash
+    end
+
+  end
+end

data/lib/onesky/resources/locale.rb

@@ -0,0 +1,9 @@
+module Resources
+  module Locale
+
+    def list_locale
+      get('/locales')
+    end
+
+  end
+end

data/lib/onesky/resources/project/base.rb

@@ -0,0 +1,23 @@
+module Resources
+  module Project
+    module Base
+
+      def show
+        get(project_path)
+      end
+
+      def update(params)
+        put(project_path, params)
+      end
+
+      def remove
+        delete(project_path)
+      end
+
+      def list_language
+        get("#{project_path}/languages")
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project/file_mgt.rb

@@ -0,0 +1,25 @@
+module Resources
+  module Project
+    module FileMgt
+
+      def list_file
+        get("#{project_path}/files")
+      end
+
+      def upload_file(params)
+        file = params[:file]
+        if file.is_a?(String)
+          raise IOError, 'File does not exist' unless File.exists?(file)
+          params[:file] = File.new(file, 'rt')
+        end
+
+        post_multipart("#{project_path}/files", params)
+      end
+
+      def delete_file(params)
+        delete("#{project_path}/files", params)
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project/import_task.rb

@@ -0,0 +1,15 @@
+module Resources
+  module Project
+    module ImportTask
+
+      def list_import_task(params = {})
+        get("#{project_path}/import-tasks", params)
+      end
+
+      def show_import_task(import_task_id)
+        get("#{project_path}/import-tasks/#{import_task_id}")
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project/order.rb

@@ -0,0 +1,19 @@
+module Resources
+  module Project
+    module Order
+
+      def list_order(params = {})
+        get("#{project_path}/orders", params)
+      end
+
+      def show_order(order_id)
+        get("#{project_path}/orders/#{order_id}")
+      end
+
+      def create_order(params)
+        post("#{project_path}/orders", params)
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project/quotation.rb

@@ -0,0 +1,11 @@
+module Resources
+  module Project
+    module Quotation
+
+      def show_quotation(params = {})
+        get("#{project_path}/quotations", params)
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project/translation.rb

@@ -0,0 +1,23 @@
+module Resources
+  module Project
+    module Translation
+
+      def export_translation(params)
+        get("#{project_path}/translations", params)
+      end
+
+      def export_multilingual(params)
+        get("#{project_path}/translations/multilingual", params)
+      end
+
+      def export_app_description(params)
+        get("#{project_path}/translations/app-descriptions", params)
+      end
+
+      def get_translation_status(params)
+        get("#{project_path}/translations/status", params)
+      end
+
+    end
+  end
+end

data/lib/onesky/resources/project.rb

@@ -0,0 +1,17 @@
+module Resources
+  module Project
+
+    def list_project(project_group_id)
+      get("/project-groups/#{project_group_id}/projects")
+    end
+
+    def create_project(project_group_id, params)
+      post("/project-groups/#{project_group_id}/projects", params)
+    end
+
+    def project(project_id)
+      Onesky::Project.new(self, project_id)
+    end
+
+  end
+end

data/lib/onesky/resources/project_group.rb

@@ -0,0 +1,25 @@
+module Resources
+  module ProjectGroup
+
+    def list_project_group
+      get('/project-groups')
+    end
+
+    def show_project_group(project_group_id)
+      get("/project-groups/#{project_group_id}")
+    end
+
+    def create_project_group(params)
+      post('/project-groups', params)
+    end
+
+    def delete_project_group(project_group_id)
+      delete("/project-groups/#{project_group_id}")
+    end
+
+    def list_project_group_languages(project_group_id)
+      get("/project-groups/#{project_group_id}/languages")
+    end
+
+  end
+end

data/lib/onesky/resources/project_type.rb

@@ -0,0 +1,9 @@
+module Resources
+  module ProjectType
+
+    def list_project_type
+      get('/project-types')
+    end
+
+  end
+end

data/lib/onesky/restclient.rb

@@ -0,0 +1,38 @@
+# Monkey patching RestClient::Request.process_url_params
+# To support array in URL params
+# RestClient.get('http://www.example.com', params: {weekday: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri']})
+# => GET http://www.example.com?weekday[]=Mon&weekday[]=Tue&weekday[]=Wed&weekday[]=Thu&weekday[]=Fri
+
+module RestClient
+  class Request
+
+    def process_url_params url, headers
+      url_params = {}
+      headers.delete_if do |key, value|
+        if 'params' == key.to_s.downcase && value.is_a?(Hash)
+          url_params.merge! value
+          true
+        else
+          false
+        end
+      end
+      unless url_params.empty?
+        query_string = url_params.collect { |k, v| build_url_params(k, v) }.join('&')
+        url + "?#{query_string}"
+      else
+        url
+      end
+    end
+
+    private
+
+    def build_url_params key, value
+      if value.is_a?(Array)
+        value.map { |v| "#{key.to_s}[]=#{CGI::escape(v.to_s)}" }.join('&')
+      else
+        "#{key.to_s}=#{CGI::escape(value.to_s)}"
+      end
+    end
+
+  end
+end

data/lib/onesky/version.rb

@@ -0,0 +1,3 @@
+module Onesky
+  VERSION = "0.0.1"
+end

data/lib/onesky.rb

@@ -0,0 +1,4 @@
+require 'onesky/version'
+require 'onesky/client'
+require 'onesky/errors'
+require 'onesky/restclient'

data/onesky-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onesky/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onesky-ruby"
+  spec.version       = Onesky::VERSION
+  spec.authors       = ["Victor Lam"]
+  spec.email         = ["victorebox@yahoo.com.hk"]
+  spec.summary       = "To interact with OneSky Platform API"
+  spec.description   = "Ruby wrapper for OneSky API"
+  spec.homepage      = "http://github.com/onesky/onesky-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 1.7'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.19"
+end

data/spec/fixture/en.yml

@@ -0,0 +1,3 @@
+en:
+  title: "Sample string file"
+  description: "This is a sample file for testing purpose"

data/spec/onesky/client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Onesky::Client do
+
+  let(:client) {Onesky::Client.new('api_key', 'api_secret')}
+
+  it 'should able to set api_key, api_secret' do
+    expect(client.api_key).to eq 'api_key'
+    expect(client.api_secret).to eq 'api_secret'
+    expect(client.auth_hash).to be_an_instance_of(Hash)
+  end
+
+end

data/spec/onesky/helpers/request_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'Helpers::Request' do
+
+  let(:api_key) {''}
+  let(:api_secret) {''}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe '#get' do
+    it 'should raise error for error response code' do
+      stub_request(:get, full_path_with_auth_hash("/locales", api_key, api_secret))
+        .to_return(status: 400, body: {meta: {code: 400, message: 'error message'}}.to_json)
+      expect {client.list_locale}.to raise_error(Onesky::Errors::BadRequestError, '400 Bad Request - error message')
+    end
+  end
+
+  describe '#post' do
+    it 'should return response on error' do
+      stub_request(:post, full_path_with_auth_hash("/project-groups", api_key, api_secret))
+        .to_return(status: 400, body: {meta: {code: 400, message: 'error message'}}.to_json)
+      expect {client.create_project_group({name: 'TEST'})}.to raise_error(Onesky::Errors::BadRequestError, '400 Bad Request - error message')
+    end
+  end
+
+  describe '#post_multipart' do
+    it 'should return response on error' do
+      stub_request(:post, full_path_with_auth_hash("/projects/#{project_id}/files", api_key, api_secret))
+        .to_return(status: 400, body: {meta: {code: 400, message: 'error message'}}.to_json)
+      expect {project.upload_file({file: 'spec/fixture/en.yml', file_format: 'RUBY_YAML'})}.to raise_error(Onesky::Errors::BadRequestError, '400 Bad Request - error message')
+    end
+  end
+
+  describe '#put' do
+    it 'should return response on error' do
+      stub_request(:put, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .to_return(status: 400, body: {meta: {code: 400, message: 'error message'}}.to_json)
+      expect {project.update({name: 'NEW NAME'})}.to raise_error(Onesky::Errors::BadRequestError, '400 Bad Request - error message')
+    end
+  end
+
+  describe '#delete' do
+    it 'should return response on error' do
+      stub_request(:delete, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .to_return(status: 400, body: {meta: {code: 400, message: 'error message'}}.to_json)
+      expect {project.remove}.to raise_error(Onesky::Errors::BadRequestError, '400 Bad Request - error message')
+    end
+  end
+
+end

data/spec/onesky/resources/locale_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Locale' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+
+  describe 'list_locale' do
+    it 'should list all available locales' do
+      stub_request(:get, full_path_with_auth_hash('/locales', api_key, api_secret))
+        .to_return(body: {})
+      response = client.list_locale
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project/base_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'Project::Base' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'show' do
+    it 'should show project information' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .to_return(body: {})
+      response = project.show
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'update' do
+    let(:params) {{name: 'New name', description: 'New project description'}}
+
+    it 'should update project information' do
+      stub_request(:put, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .to_return(status: 200)
+      response = project.update(params)
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe 'remove' do
+    it 'should delete a project' do
+      stub_request(:delete, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .to_return(status: 200)
+      response = project.remove
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe 'list_language' do
+    it 'should list languages of project' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/languages", api_key, api_secret))
+        .to_return(body: {})
+      response = project.list_language
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project/file_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'Project::File' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'list_file' do
+    it 'should list files in project' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/files", api_key, api_secret))
+        .to_return(body: {})
+      response = project.list_file
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'upload_file' do
+    let(:params) {{file: 'spec/fixture/en.yml', file_format: 'RUBY_YAML'}}
+
+    it 'should upload file to project' do
+      stub_request(:post, full_path_with_auth_hash("/projects/#{project_id}/files", api_key, api_secret))
+        .to_return(body: {})
+      response = project.upload_file(params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+
+    it 'should raise error when file does not exist' do
+      expect {project.upload_file(file: 'spec/fixture/no_file.yml')}.to raise_error(IOError, 'File does not exist')
+    end
+  end
+
+  describe 'delete_file' do
+    let(:params) {{file_name: 'en.yml'}}
+    let(:params_as_query_string) {'&file_name=en.yml'}
+
+    it 'should delete file from project' do
+      stub_request(:delete, full_path_with_auth_hash("/projects/#{project_id}/files", api_key, api_secret) + params_as_query_string)
+        .to_return(body: {})
+      response = project.delete_file(params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project/import_task_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'Project::ImportTask' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'list_import_task' do
+    it 'should list import tasks of the project' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/import-tasks", api_key, api_secret))
+        .to_return(body: {})
+      response = project.list_import_task
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'show_import_task' do
+    let(:import_task_id) {1}
+
+    it 'should show an import task details' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/import-tasks/#{import_task_id}", api_key, api_secret))
+        .to_return(body: {})
+      response = project.show_import_task(import_task_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project/order_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'Project::Order' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'list_order' do
+    it 'should list orders in project' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/orders", api_key, api_secret))
+        .to_return(status: 200, body: {})
+      response = project.list_order
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'show_order' do
+    let(:order_id) {1}
+
+    it 'should show an order details' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/orders/#{order_id}", api_key, api_secret))
+        .to_return(status: 200, body: {})
+      response = project.show_order(order_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'create_order' do
+    let(:files) {['en.yml', 'en2.yml']}
+    let(:to_locale) {'ja'}
+    let(:params) {{files: files, to_locale: to_locale}}
+
+    it 'should create an order' do
+      stub_request(:post, full_path_with_auth_hash("/projects/#{project_id}/orders", api_key, api_secret))
+        .with(body: params.to_json, headers: {'Content_Type' => 'application/json'})
+        .to_return(status: 200, body: {})
+      response = project.create_order(params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project/quotation_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Project::Quotation' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'show_quotation' do
+    let(:params) {{files: ['en.yml', 'en2.yml'], to_locale: 'ja'}}
+    let(:params_as_query_string) {'&files[]=en.yml&files[]=en2.yml&to_locale=ja'}
+
+    it 'should show quotation details' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/quotations", api_key, api_secret) + params_as_query_string)
+        .to_return(status: 200)
+      response = project.show_quotation(params)
+      expect(response.code).to eq(200)
+    end
+  end
+
+end

data/spec/onesky/resources/project/translation_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe 'Project::Translation' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+  let(:project_id) {1}
+  let(:project) {client.project(project_id)}
+
+  describe 'export_translation' do
+    let(:params) {{source_file_name: 'en.yml', locale: 'ja'}}
+    let(:params_as_query_string) {'&source_file_name=en.yml&locale=ja'}
+
+    it 'should export translation' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/translations", api_key, api_secret) + params_as_query_string)
+        .to_return(status: 200, body: 'file content')
+      response = project.export_translation(params)
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe 'export_multilingual' do
+    let(:params) {{source_file_name: 'en.yml'}}
+    let(:params_as_query_string) {'&source_file_name=en.yml'}
+
+    it 'should export multilingual' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/translations/multilingual", api_key, api_secret) + params_as_query_string)
+        .to_return(status: 200, body: 'file content')
+      response = project.export_multilingual(params)
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe 'export_app_description' do
+    let(:params) {{locale: 'ja'}}
+    let(:params_as_query_string) {'&locale=ja'}
+
+    it 'should export app description' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/translations/app-descriptions", api_key, api_secret) + params_as_query_string)
+        .to_return(status: 200, body: 'file content')
+      response = project.export_app_description(params)
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe 'get_translation_status' do
+    let(:params) {{file_name: 'en.yml', locale: 'ja'}}
+    let(:params_as_query_string) {'&file_name=en.yml&locale=ja'}
+
+    it 'should show translation status' do
+      stub_request(:get, full_path_with_auth_hash("/projects/#{project_id}/translations/status", api_key, api_secret) + params_as_query_string)
+        .to_return(body: {})
+      response = project.get_translation_status(params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project_group_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'Project Group' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+
+  describe 'list_project_group' do
+    it 'should list all available project group' do
+      stub_request(:get, full_path_with_auth_hash('/project-groups', api_key, api_secret))
+        .to_return(body: {})
+      response = client.list_project_group
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'show_project_group' do
+    let(:project_group_id) {1}
+
+    it 'should show a project group information' do
+      stub_request(:get, full_path_with_auth_hash("/project-groups/#{project_group_id}", api_key, api_secret))
+        .to_return(body: {})
+      response = client.show_project_group(project_group_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'create_project_group' do
+    let(:params) {{name: 'New Project Group'}}
+
+    it 'should create a project group' do
+      stub_request(:post, full_path_with_auth_hash('/project-groups', api_key, api_secret))
+        .with(body: params.to_json, headers: {'Content_Type' => 'application/json'})
+        .to_return(body: {})
+      response = client.create_project_group(params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'delete_project_group' do
+    let(:project_group_id) {1}
+
+    it 'should delete a project group' do
+      stub_request(:delete, full_path_with_auth_hash("/project-groups/#{project_group_id}", api_key, api_secret))
+        .to_return(body: {})
+      response = client.delete_project_group(project_group_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'list_project_group_languages' do
+    let(:project_group_id) {1}
+
+    it 'should list languages activated of a project group' do
+      stub_request(:get, full_path_with_auth_hash("/project-groups/#{project_group_id}/languages", api_key, api_secret))
+        .to_return(body: {})
+      response = client.list_project_group_languages(project_group_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/onesky/resources/project_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'Project' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+
+  describe 'list_project' do
+    let(:project_group_id) {1}
+
+    it 'should list all projects of a project group' do
+      stub_request(:get, full_path_with_auth_hash("/project-groups/#{project_group_id}/projects", api_key, api_secret))
+        .to_return(body: {})
+      response = client.list_project(project_group_id)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'create_project' do
+    let(:project_group_id) {1}
+    let(:params) {{project_type: 'website'}}
+
+    it 'should list all projects of a project group' do
+      stub_request(:post, full_path_with_auth_hash("/project-groups/#{project_group_id}/projects", api_key, api_secret))
+        .with(body: params.to_json, headers: {'Content_Type' => 'application/json'})
+        .to_return(body: {})
+      response = client.create_project(project_group_id, params)
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+  describe 'project' do
+    let(:project_id) {1}
+
+    it 'get project object' do
+      expect(client.project(project_id)).to be_an_instance_of(Onesky::Project)
+    end
+  end
+
+end

data/spec/onesky/resources/project_type_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Project Type' do
+
+  let(:api_key) {'api_key'}
+  let(:api_secret) {'api_secret'}
+  let(:client) {Onesky::Client.new(api_key, api_secret)}
+
+  describe 'list_project_type' do
+    it 'should list all available project type' do
+      stub_request(:get, full_path_with_auth_hash('/project-types', api_key, api_secret))
+        .to_return(body: {})
+      response = client.list_project_type
+      expect(response).to be_an_instance_of(Hash)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'digest'
+require 'onesky'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+def auth_query_string(api_key, api_secret)
+  now = Time.now.to_i
+  output = '?'
+  output += "api_key=#{api_key}"
+  output += "&timestamp=#{now.to_s}"
+  output += "&dev_hash=#{Digest::MD5.hexdigest(now.to_s + api_secret)}"
+
+  output
+end
+
+def full_path_with_auth_hash(path, api_key, api_secret)
+  "#{Helpers::Request::ENDPOINT}/#{Helpers::Request::VERSION}#{path}#{auth_query_string(api_key, api_secret)}"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: onesky-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Lam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+description: Ruby wrapper for OneSky API
+email:
+- victorebox@yahoo.com.hk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onesky.rb
+- lib/onesky/client.rb
+- lib/onesky/errors.rb
+- lib/onesky/helpers/request.rb
+- lib/onesky/project.rb
+- lib/onesky/resources/locale.rb
+- lib/onesky/resources/project.rb
+- lib/onesky/resources/project/base.rb
+- lib/onesky/resources/project/file_mgt.rb
+- lib/onesky/resources/project/import_task.rb
+- lib/onesky/resources/project/order.rb
+- lib/onesky/resources/project/quotation.rb
+- lib/onesky/resources/project/translation.rb
+- lib/onesky/resources/project_group.rb
+- lib/onesky/resources/project_type.rb
+- lib/onesky/restclient.rb
+- lib/onesky/version.rb
+- onesky-ruby.gemspec
+- spec/fixture/en.yml
+- spec/onesky/client_spec.rb
+- spec/onesky/helpers/request_spec.rb
+- spec/onesky/resources/locale_spec.rb
+- spec/onesky/resources/project/base_spec.rb
+- spec/onesky/resources/project/file_spec.rb
+- spec/onesky/resources/project/import_task_spec.rb
+- spec/onesky/resources/project/order_spec.rb
+- spec/onesky/resources/project/quotation_spec.rb
+- spec/onesky/resources/project/translation_spec.rb
+- spec/onesky/resources/project_group_spec.rb
+- spec/onesky/resources/project_spec.rb
+- spec/onesky/resources/project_type_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/onesky/onesky-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.2.2
+signing_key: 
+specification_version: 4
+summary: To interact with OneSky Platform API
+test_files:
+- spec/fixture/en.yml
+- spec/onesky/client_spec.rb
+- spec/onesky/helpers/request_spec.rb
+- spec/onesky/resources/locale_spec.rb
+- spec/onesky/resources/project/base_spec.rb
+- spec/onesky/resources/project/file_spec.rb
+- spec/onesky/resources/project/import_task_spec.rb
+- spec/onesky/resources/project/order_spec.rb
+- spec/onesky/resources/project/quotation_spec.rb
+- spec/onesky/resources/project/translation_spec.rb
+- spec/onesky/resources/project_group_spec.rb
+- spec/onesky/resources/project_spec.rb
+- spec/onesky/resources/project_type_spec.rb
+- spec/spec_helper.rb
+has_rdoc: