calx_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b63479923ef59460370bd9e4e3aecccf0a01103
+  data.tar.gz: 349ee83773fd8b207229c94555c151e952c2a166
+SHA512:
+  metadata.gz: 9a3ff2304d4cc0c04a45eaccc4c90eb58093f6483a49937f05cfa1cc7f30725cf784d71df9e05f07ea95366aa7624947c3d8a2866af5f47c02220a1134d0aa58
+  data.tar.gz: a5407fa15f2b713e092ab8a19aa7103118b3b34821cf52d820e27c851af57e90a35bbc9eae72e0a7f539237d6adbceb232962b73e449cfde974d0fe5335549cb

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    calx_client (0.0.1)
+      api-auth
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    api-auth (2.1.0)
+    ast (2.3.0)
+    coveralls (0.8.17)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    hashdiff (0.3.2)
+    json (2.0.2)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    public_suffix (2.0.5)
+    rainbow (2.2.1)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.13.0)
+    unicode-display_width (1.1.2)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  calx_client!
+  coveralls
+  rake
+  rspec
+  rubocop
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright © 2017 Mert Guldur
+
+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,8 @@
+# CalX Client
+
+[![Build
+Status](https://travis-ci.org/mertguldur/calx_client.svg?branch=master)](https://travis-ci.org/mertguldur/calx_client)
+[![Coverage
+Status](https://coveralls.io/repos/github/mertguldur/calx_client/badge.svg?branch=master)](https://coveralls.io/github/mertguldur/calx_client?branch=master)
+
+Ruby API client to access CalX events.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/calx_client.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('lib/calx_client/version', File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name        = 'calx_client'
+  s.version     = CalX::VERSION
+  s.date        = '2016-12-09'
+  s.summary     = 'CalX API Client'
+  s.description = 'API client to access CalX events'
+  s.authors     = ['Mert Guldur']
+  s.email       = 'mertguldur@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.license     = 'MIT'
+
+  s.add_dependency 'api-auth'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+end

data/lib/calx_client.rb

@@ -0,0 +1,123 @@
+module CalX
+  class Error < StandardError; end
+  class ServerError < Error; end
+  class ClientError < Error; end
+  class AuthenticationError < ClientError; end
+
+  class Client
+    def initialize(access_id, secret_key, options = {})
+      @access_id = access_id
+      @secret_key = secret_key
+      @host = host(options)
+    end
+
+    def authorize(user_id)
+      post('/app_authorization_requests', user_id: user_id)
+    end
+
+    def events(user_id, params = {})
+      get("/users/#{user_id}/events", params)
+    end
+
+    def event(event_id)
+      get("/events/#{event_id}")
+    end
+
+    def create_event(user_id, params)
+      post("/users/#{user_id}/events", params)
+    end
+
+    def update_event(event_id, params)
+      put("/events/#{event_id}", params)
+    end
+
+    def delete_event(event_id)
+      delete("/events/#{event_id}")
+    end
+
+    private
+
+    def get(request_uri, params = {})
+      request_uri += "?#{encode_params(params)}" unless params.nil?
+      uri = URI(@host + request_uri)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request(uri, request)
+    end
+
+    def post(request_uri, params)
+      uri = URI(@host + request_uri)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.form_data = params
+      request(uri, request)
+    end
+
+    def put(request_uri, params)
+      uri = URI(@host + request_uri)
+      request = Net::HTTP::Put.new(uri.request_uri)
+      request.form_data = params
+      request(uri, request)
+    end
+
+    def delete(request_uri)
+      uri = URI(@host + request_uri)
+      request = Net::HTTP::Delete.new(uri.request_uri)
+      request(uri, request)
+    end
+
+    def request(uri, request)
+      signed_request = ApiAuth.sign!(request, @access_id, @secret_key)
+      response = http(uri).request(signed_request)
+      parse_response(uri, response)
+    end
+
+    def parse_response(uri, response)
+      case response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        parse_success_response(response)
+      when Net::HTTPUnauthorized
+        raise AuthenticationError.new(error_response_message(response, uri))
+      when Net::HTTPClientError
+        raise ClientError.new(error_response_message(response, uri))
+      when Net::HTTPServerError
+        raise ServerError.new(error_response_message(response, uri))
+      else
+        raise Error.new(error_response_message(response, uri))
+      end
+    end
+
+    def parse_success_response(response)
+      if response['Content-Type'].split(';').first == 'application/json'
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def error_response_message(response, uri)
+      message = "#{response.code} response from #{uri.host}"
+      message + " | Response body: #{JSON.parse(response.body)}" unless response.body.nil?
+    end
+
+    def http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.is_a?(URI::HTTPS)
+      http
+    end
+
+    def host(options = {})
+      (options[:host] || 'http://localhost:3000') + '/api/v1'
+    end
+
+    def encode_params(params)
+      params.flat_map do |k, vs|
+        Array(vs).map { |v| "#{escape_component(k)}=#{escape_component(v)}" }
+      end.join('&')
+    end
+
+    def escape_component(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/spec/calx_client_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+require 'api-auth'
+require 'webmock/rspec'
+
+describe CalX::Client do
+  let(:host) { 'http://localhost:3000/api/v1' }
+  let(:headers) { { 'Content-Type' => 'application/json' } }
+
+  subject { described_class.new('test_tenant', '12345') }
+
+  describe '#authorize' do
+    let(:user_id) { '1' }
+    let(:tenant_id) { '1' }
+    let(:response_body) { { 'user_id' => user_id, 'tenant_id' => tenant_id } }
+
+    before do
+      stub_request(:post, "#{host}/app_authorization_requests").
+        with(body: { user_id: user_id }).
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the app authorization request' do
+      expect(subject.authorize(user_id)).to eq(response_body)
+    end
+  end
+
+  describe '#events' do
+    let(:user_id) { '1' }
+    let(:date) { Date.today }
+    let(:response_body) do
+      { 'user_id' => user_id, 'event_id' => '1' }
+    end
+
+    before do
+      stub_request(:get, "#{host}/users/#{user_id}/events").
+        with(query: hash_including('date' => date.to_s)).
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the events' do
+      expect(subject.events(user_id, date: date)).to eq(response_body)
+    end
+  end
+
+  describe '#event' do
+    let(:event_id) { '1' }
+    let(:response_body) do
+      { 'event_id' => event_id }
+    end
+
+    before do
+      stub_request(:get, "#{host}/events/#{event_id}").
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the event' do
+      expect(subject.event(event_id)).to eq(response_body)
+    end
+  end
+
+  describe '#create_event' do
+    let(:user_id) { '1' }
+    let(:event_id) { '1' }
+    let(:event_params) do
+      { 'title' => 'test' }
+    end
+    let(:response_body) do
+      { 'event_id' => event_id, 'title' => 'test' }
+    end
+
+    before do
+      stub_request(:post, "#{host}/users/#{user_id}/events").
+        with(body: event_params).
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the created event' do
+      expect(subject.create_event(user_id, event_params)).to eq(response_body)
+    end
+  end
+
+  describe '#update_event' do
+    let(:event_id) { '1' }
+    let(:event_params) do
+      { 'title' => 'test' }
+    end
+    let(:response_body) do
+      { 'event_id' => event_id, 'title' => 'test' }
+    end
+
+    before do
+      stub_request(:put, "#{host}/events/#{event_id}").
+        with(body: event_params).
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the updated event' do
+      expect(subject.update_event(event_id, event_params)).to eq(response_body)
+    end
+  end
+
+  describe '#delete_event' do
+    let(:event_id) { '1' }
+    let(:response_body) do
+      { 'event_id' => event_id, 'title' => 'test' }
+    end
+
+    before do
+      stub_request(:delete, "#{host}/events/#{event_id}").
+        to_return(body: response_body.to_json, status: 200, headers: headers)
+    end
+
+    it 'returns the deleted event' do
+      expect(subject.delete_event(event_id)).to eq(response_body)
+    end
+  end
+
+  context 'text body' do
+    let(:event_id) { 1 }
+    let(:headers) { { 'Content-Type' => 'application/text' } }
+
+    before do
+      stub_request(:get, "#{host}/events/#{event_id}").
+        to_return(body: 'test', status: 200, headers: headers)
+    end
+
+    it 'returns the text body' do
+      expect(subject.event(event_id)).to eq('test')
+    end
+  end
+
+  context 'error cases' do
+    let(:event_id) { 1 }
+
+    before do
+      stub_request(:get, "#{host}/events/#{event_id}").
+        to_return(body: '', status: status_code, headers: headers)
+    end
+
+    context 'HTTP no content' do
+      let(:status_code) { 204 }
+
+      it 'is no content' do
+        expect(subject.event(event_id)).to eq(:no_content)
+      end
+    end
+
+    context 'HTTP unauthorized' do
+      let(:status_code) { 401 }
+
+      it 'raises AuthenticationError' do
+        expect do
+          subject.event(event_id)
+        end.to raise_error(CalX::AuthenticationError)
+      end
+    end
+
+    context 'HTTP client error' do
+      let(:status_code) { 400 }
+
+      it 'raises ClientError' do
+        expect do
+          subject.event(event_id)
+        end.to raise_error(CalX::ClientError)
+      end
+    end
+
+    context 'HTTP server error' do
+      let(:status_code) { 500 }
+
+      it 'raises ServerError' do
+        expect do
+          subject.event(event_id)
+        end.to raise_error(CalX::ServerError)
+      end
+    end
+
+    context 'HTTP client error' do
+      let(:status_code) { 308 }
+
+      it 'raises Error' do
+        expect do
+          subject.event(event_id)
+        end.to raise_error(CalX::Error)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter,
+]
+
+SimpleCov.start
+
+require 'calx_client'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: calx_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mert Guldur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: coveralls
+  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: API client to access CalX events
+email: mertguldur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- calx_client.gemspec
+- lib/calx_client.rb
+- spec/calx_client_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.6.8
+signing_key: 
+specification_version: 4
+summary: CalX API Client
+test_files: []