clx_api 0.1.0

data/test/http_client_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+class HTTPClientTest < MiniTest::Test
+  
+  def setup
+    http_adapter = CLX::TestAdapter.new
+    http_adapter.set_auth('username', 'password')
+    @base_url = 'http://base.url.org/api'
+    @client = CLX::HTTPClient.new @base_url, http_adapter
+  end
+
+  def test_initializer
+    assert_instance_of CLX::HTTPClient, @client
+  end
+
+  def test_request_resource_list_returns_array_of_open_struct
+    response = OpenStruct.new(
+      body: '[
+        {"id":1,"name":"Foo","network":"Foonetwork","uniqueName":"Foo uniquq","isoCountryCode":"8","operationalState":"active","operationalStatDate":"-0001-11-30 00:00:00","numberOfSubscribers":0},
+        {"id":1058,"name":"Bar mobile","network":"Bar Mobile","uniqueName":"Foo Mobile-unique","isoCountryCode":"8","operationalState":"active","operationalStatDate":"-0001-11-30 00:00:00","numberOfSubscribers":0}
+      ]',
+      code: 200
+    )
+    @client.http_adapter.response = response
+    path = '/operator'
+    full_url = @base_url + path
+
+    result = @client.get(path)
+
+    assert_equal result.length, 2
+    assert_equal result[0].id, 1
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+  def test_request_single_resource_returns_open_struct
+    response = OpenStruct.new(
+      body: '{"id":1,"name":"Foo","network":"Foonetwork","uniqueName":"Foo uniquq","isoCountryCode":"8","operationalState":"active","operationalStatDate":"-0001-11-30 00:00:00","numberOfSubscribers":0}',
+      code: 200
+    )
+    @client.http_adapter.response = response
+    path = '/operator/1'
+    full_url = @base_url + path
+
+    result = @client.get(path)
+    
+    assert_equal result.id, 1
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+  def test_get_request_to_resource_that_does_not_exist_raises_clx_exception_
+    response = OpenStruct.new(
+      body: '{"error":{"message": "No operator with id: 9999", "code": 3001}}',
+      code: 404
+    )
+    @client.http_adapter.response = response
+    path = '/operator/9999'
+    full_url = @base_url + path
+
+    assert_raises CLX::CLXAPIException do
+      #test http-code == 404
+      result = @client.get(path)
+    end
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+  def test_post_returns_data_hash_as_open_struct
+    data = {id: 1, key: 'value'}
+    response = OpenStruct.new(
+      body: data.to_json,
+      code: 201
+    )
+    @client.http_adapter.response = response
+    path = '/post-path'
+    full_url = @base_url + path
+
+    result = @client.post(path, data)
+
+    assert_equal data[:id], result.id
+    assert_equal data[:key], result.key
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'POST'
+  end
+
+  def test_put_returns_modified_data_hash_as_open_struct
+    data = {id: 1, key: 'value'}
+    data[:key] = 'new value'
+    response = OpenStruct.new(
+      body: data.to_json,
+      code: 200
+    )
+    @client.http_adapter.response = response
+    path = '/put-path'
+    full_url = @base_url + path
+
+    result = @client.put(path, data)
+
+    assert_equal data[:id], result.id
+    assert_equal data[:key], result.key
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'PUT'
+  end
+
+  def test_delete_returns_empty_open_struct
+    response = OpenStruct.new(
+      body: '{}',
+      code: 204
+    )
+    @client.http_adapter.response = response
+    path = '/delete-path'
+    full_url = @base_url + path
+
+    result = @client.delete(path)
+
+    assert_empty result.to_h
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'DELETE'
+  end
+
+  def test_parser_with_invalid_json_raises_clx_exception
+    response = OpenStruct.new(
+      body: '{not_valid_json \not :at all',
+      code: 200
+    )
+    @client.http_adapter.response = response
+
+    path = '/invalid-json-response'
+    full_url = @base_url + path
+
+    assert_raises CLX::CLXException do
+      @client.get(path)
+    end
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+  def test_reponse_with_unknown_http_status_code_with_error_raises_clx_api_exception
+    response = OpenStruct.new(
+      body: '{"message": "strage error", "code": 1234}',
+      code: 410
+    )
+    @client.http_adapter.response = response
+
+    path = '/invalid-unknown-http-code-with-error'
+    full_url = @base_url + path
+
+    assert_raises CLX::CLXAPIException do
+      @client.get(path)
+    end
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+  def test_response_with_unknown_http_status_code_but_no_errors_raises_clx_api_exception
+    response = OpenStruct.new(
+      body: '{}',
+      code: 410
+    )
+    @client.http_adapter.response = response
+
+    path = '/invalid-unknown-http-code-without-error'
+    full_url = @base_url + path
+
+    assert_raises CLX::CLXAPIException do
+      @client.get(path)
+    end
+    assert_equal @client.http_adapter.request_url, full_url
+    assert_equal @client.http_adapter.request_method, 'GET'
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+require 'json'
+SimpleCov.start
+
+require 'clx_api'
+require 'adapter/test_adapter'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: clx_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Fridlund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Ruby Gem for CLX Networks API.
+email:
+- afrxx09@student.lnu.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clx_api.gemspec
+- doc/CLX.html
+- doc/CLX/API.html
+- doc/CLX/CLXAPIException.html
+- doc/CLX/CLXException.html
+- doc/CLX/HTTPAdapter.html
+- doc/CLX/HTTPClient.html
+- doc/ClxApi.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- examples/get_gateway_by_id.rb
+- examples/get_gateways.rb
+- examples/get_operator_by_id.rb
+- examples/get_operators.rb
+- examples/get_price_entries_by_gateway_id.rb
+- examples/get_price_entries_by_gateway_id_and_operator_id.rb
+- examples/get_price_entries_by_gateway_id_and_operator_id_and_date.rb
+- examples/readme.md
+- lib/clx_api.rb
+- lib/clx_api/api.rb
+- lib/clx_api/exceptions/clx_api_exception.rb
+- lib/clx_api/exceptions/clx_exception.rb
+- lib/clx_api/http_adapter.rb
+- lib/clx_api/http_client.rb
+- lib/clx_api/version.rb
+- test/adapter/test_adapter.rb
+- test/api_test.rb
+- test/http_adapter_test.rb
+- test/http_client_test.rb
+- test/test_helper.rb
+homepage: https://clxnetworks.com/
+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.4.6
+signing_key: 
+specification_version: 4
+summary: CLX Networks API Gem.
+test_files:
+- test/adapter/test_adapter.rb
+- test/api_test.rb
+- test/http_adapter_test.rb
+- test/http_client_test.rb
+- test/test_helper.rb
+has_rdoc: