onesky-ruby 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07702d69f7f7c3651594e79cf6dbd6e3bdf35205
-  data.tar.gz: f4bfd6c6a08a1b2ad6747d317bd676bd175989e7
+  metadata.gz: 09e973e24c4068bc89d7dd58f2f6b1ce604b35ec
+  data.tar.gz: 20410a85721b13430449b86e3c3e6de496ee1c8c
 SHA512:
-  metadata.gz: 6f995fba3cc6aa9486a467474ed9b041fb4132a1222c3a787699ed0da7a718aa74e6bb1d8a3aa4869036a8cfbc0c47579dcdb9327a11351cdb7f4abcab1bdffa
-  data.tar.gz: 182b75526c85377c628084bf88920d605aff30af196e90fd1514b89c5835e531a6f5f4f4bb18f41022933b34e0d7e1162a3ca8180eaed6b42f1e41f8ed9b296b
+  metadata.gz: df3f27cdc68d27a9dda0f720a5071bdc4e4dab4dc03533297d88919a5c97b72229478161842bda57703351199f4a88b063b9a729cd2b641d74b33c913fee7755
+  data.tar.gz: 33cecc02abc92d9bde46515a6e1443045ce2dc1576e60551c730027be71aa50eb6e4d2db3d9786c87e9f138b24fa25f60c31b6e2a76f0a23d1a83887c279e2a9

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+### 0.0.1 - 23-OCT-2014
+
+* Add client for non-project resources
+  * project group
+  * project type
+  * locales
+  * project (partially)
+
+* Add project for project based resources
+  * project
+  * file
+  * translation
+  * import task
+  * order
+  * quotation
+
+### 1.0.0 - 31-DEC-2014
+
+* Add custom header for OneSky
+* Set as stable version

data/README.md

@@ -1,5 +1,7 @@
 # OneSky - Ruby client
 
+[![Build Status](https://travis-ci.org/onesky/onesky-ruby.svg)](https://travis-ci.org/onesky/onesky-ruby)
+
 Ruby client for [OneSky](http://www.oneskyapp.com) [Platform API](/onesky/api-documentation-platform)
 
 ## Installation
@@ -60,7 +62,7 @@ File.open('path/to/target/file', 'w') { |file| file.write(resp)}
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/onesky-ruby/fork )
+1. Fork it ( http://github.com/onesky/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`)

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) { |t| t.verbose = false }
+
+  task :default => :spec
+rescue LoadError
+  p "no rspec available"
+end

data/lib/onesky/client.rb

@@ -15,11 +15,14 @@ module Onesky
     include Resources::Project
     include Helpers::Request
 
-    attr_accessor :api_key, :api_secret, :project_id
+    attr_accessor :api_key, :api_secret, :project_id, :plugin_code
 
     def initialize(key, secret)
       @api_key = key
       @api_secret = secret
+
+      # Plugin code for custom header
+      @plugin_code = 'ruby-wrapper'
     end
 
     def auth_hash

data/lib/onesky/helpers/request.rb

@@ -10,35 +10,57 @@ module Helpers
 
     def get(path, params = {})
       uri = uri_prefix + path
-      RestClient.get(uri, params: auth_hash.merge(params)) do |resp, req, result|
+      params = {
+        content_type: :json,
+        params: auth_hash.merge(params),
+      }.merge(custom_header)
+
+      RestClient.get(uri, 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|
+      params = {
+        content_type: :json,
+        params: auth_hash,
+      }.merge(custom_header)
+
+      RestClient.post(uri, body_hash.to_json, params) 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|
+      params = {params: auth_hash}.merge(custom_header)
+
+      RestClient.post(uri, body_hash.merge({multipart: true}), params) 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|
+      params = {
+        content_type: :json,
+        params: auth_hash,
+      }.merge(custom_header)
+
+      RestClient.put(uri, body_hash.to_json, params) 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|
+      params = {
+        content_type: :json,
+        params: auth_hash.merge(params)
+      }.merge(custom_header)
+
+      RestClient.delete(uri, params) do |resp, req, result|
         handle_error(resp)
       end
     end
@@ -78,5 +100,9 @@ module Helpers
       ''
     end
 
+    def custom_header
+      {'Onesky-Plugin' => @plugin_code}
+    end
+
   end
 end

data/lib/onesky/project.rb

@@ -22,6 +22,8 @@ module Onesky
     def initialize(client, id)
       @client = client
       @project_id = id
+
+      @plugin_code = client.plugin_code
     end
 
     private

data/lib/onesky/version.rb

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

data/onesky-ruby.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rest-client', '~> 1.7'
+  spec.add_dependency 'rest-client', '~> 1.7.2'
 
   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"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "webmock", "~> 1.19.0"
 end

data/spec/onesky/helpers/request_spec.rb

@@ -7,8 +7,16 @@ describe 'Helpers::Request' do
   let(:client) {Onesky::Client.new(api_key, api_secret)}
   let(:project_id) {1}
   let(:project) {client.project(project_id)}
+  let(:http_header) {{'Content-Type' => 'application/json', 'Onesky-Plugin' => 'ruby-wrapper'}}
 
   describe '#get' do
+    it 'should initial request with required headers' do
+      stub_request(:get, full_path_with_auth_hash("/locales", api_key, api_secret))
+        .with(headers: http_header)
+        .to_return(body: {})
+      expect(client.list_locale).to be_an_instance_of(Hash)
+    end
+
     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)
@@ -17,6 +25,13 @@ describe 'Helpers::Request' do
   end
 
   describe '#post' do
+    it 'should initial request with required headers' do
+      stub_request(:post, full_path_with_auth_hash("/project-groups", api_key, api_secret))
+        .with(headers: http_header)
+        .to_return(body: {})
+      expect(client.create_project_group({name: 'TEST'})).to be_an_instance_of(Hash)
+    end
+
     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)
@@ -25,6 +40,13 @@ describe 'Helpers::Request' do
   end
 
   describe '#post_multipart' do
+    it 'should initial request with required headers' do
+      stub_request(:post, full_path_with_auth_hash("/projects/#{project_id}/files", api_key, api_secret))
+        .with(headers: {'Onesky-Plugin' => 'ruby-wrapper'})
+        .to_return(body: {})
+      expect(project.upload_file({file: 'spec/fixture/en.yml', file_format: 'RUBY_YAML'})).to be_an_instance_of(Hash)
+    end
+
     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)
@@ -33,6 +55,13 @@ describe 'Helpers::Request' do
   end
 
   describe '#put' do
+    it 'should initial request with required headers' do
+      stub_request(:put, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .with(headers: http_header)
+        .to_return(body: {})
+      expect(project.update({name: 'NEW NAME'})).to be_an_instance_of(Hash)
+    end
+
     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)
@@ -41,6 +70,13 @@ describe 'Helpers::Request' do
   end
 
   describe '#delete' do
+    it 'should initial request with required headers' do
+      stub_request(:delete, full_path_with_auth_hash("/projects/#{project_id}", api_key, api_secret))
+        .with(headers: http_header)
+        .to_return(body: {})
+      expect(project.remove).to be_an_instance_of(Hash)
+    end
+
     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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesky-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Victor Lam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.19.0
 description: Ruby wrapper for OneSky API
 email:
 - victorebox@yahoo.com.hk
@@ -89,6 +89,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md