RubyGems - clx_api - Versions diffs - 0.1.0 - Mend

Files changed (50) hide show

checksums.yaml +7 -0
data/.gitignore +13 -0
data/.yardopts +1 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +55 -0
data/Rakefile +7 -0
data/clx_api.gemspec +26 -0
data/doc/CLX.html +305 -0
data/doc/CLX/API.html +1491 -0
data/doc/CLX/CLXAPIException.html +411 -0
data/doc/CLX/CLXException.html +134 -0
data/doc/CLX/HTTPAdapter.html +1294 -0
data/doc/CLX/HTTPClient.html +1058 -0
data/doc/ClxApi.html +141 -0
data/doc/_index.html +161 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +112 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +112 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +279 -0
data/doc/top-level-namespace.html +112 -0
data/examples/get_gateway_by_id.rb +16 -0
data/examples/get_gateways.rb +18 -0
data/examples/get_operator_by_id.rb +21 -0
data/examples/get_operators.rb +23 -0
data/examples/get_price_entries_by_gateway_id.rb +19 -0
data/examples/get_price_entries_by_gateway_id_and_operator_id.rb +17 -0
data/examples/get_price_entries_by_gateway_id_and_operator_id_and_date.rb +18 -0
data/examples/readme.md +167 -0
data/lib/clx_api.rb +35 -0
data/lib/clx_api/api.rb +132 -0
data/lib/clx_api/exceptions/clx_api_exception.rb +25 -0
data/lib/clx_api/exceptions/clx_exception.rb +8 -0
data/lib/clx_api/http_adapter.rb +129 -0
data/lib/clx_api/http_client.rb +163 -0
data/lib/clx_api/version.rb +4 -0
data/test/adapter/test_adapter.rb +67 -0
data/test/api_test.rb +306 -0
data/test/http_adapter_test.rb +211 -0
data/test/http_client_test.rb +173 -0
data/test/test_helper.rb +7 -0
metadata +168 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="CLX.html" title="CLX (module)">CLX</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Mon May 25 12:34:49 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.1.5).
+</div>
+  </body>
+</html>

data/examples/get_gateway_by_id.rb ADDED Viewed

@@ -0,0 +1,16 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  gateway = clx.get_gateway_by_id(6)
+  puts gateway.id
+  puts gateway.name
+  puts gateway.type
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_gateways.rb ADDED Viewed

@@ -0,0 +1,18 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  gateways = clx.get_gateways
+  gateways.each do |gateway|
+    puts gateway.id
+    puts gateway.name
+    puts gateway.type
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_operator_by_id.rb ADDED Viewed

@@ -0,0 +1,21 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  operator = clx.get_operator_by_id(6)
+  puts operator.id
+  puts operator.name
+  puts operator.network
+  puts operator.uniqueName
+  puts operator.isoCountryCode
+  puts operator.operationalState
+  puts operator.operationalStatDate
+  puts operator.numberOfSubscribers
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_operators.rb ADDED Viewed

@@ -0,0 +1,23 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  operators = clx.get_operators
+  operators.each do |operator|
+    puts operator.id
+    puts operator.name
+    puts operator.network
+    puts operator.uniqueName
+    puts operator.isoCountryCode
+    puts operator.operationalState
+    puts operator.operationalStatDate
+    puts operator.numberOfSubscribers
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_price_entries_by_gateway_id.rb ADDED Viewed

@@ -0,0 +1,19 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  prices = clx.get_price_entires_by_gateway_id(6)
+  prices.each do |price|
+    puts price.price
+    puts price.gateway
+    puts price.operator
+    puts price.expireDate
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_price_entries_by_gateway_id_and_operator_id.rb ADDED Viewed

@@ -0,0 +1,17 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  price = clx.get_price_entries_by_gateway_id_and_operator_id(6, 1)
+  puts price.price
+  puts price.gateway
+  puts price.operator
+  puts price.expireDate
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/get_price_entries_by_gateway_id_and_operator_id_and_date.rb ADDED Viewed

@@ -0,0 +1,18 @@
+begin
+  clx = CLX::API.new('username', 'password')
+  date = DateTime.new(2015, 5, 25)
+  price = clx.get_price_entries_by_gateway_id_and_operator_id_and_date(6, 1, date)
+  puts price.price
+  puts price.gateway
+  puts price.operator
+  puts price.expireDate
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end

data/examples/readme.md ADDED Viewed

@@ -0,0 +1,167 @@
+#Examples
+## Get operators
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  operators = clx.get_operators
+  operators.each do |operator|
+    puts operator.id
+    puts operator.name
+    puts operator.network
+    puts operator.uniqueName
+    puts operator.isoCountryCode
+    puts operator.operationalState
+    puts operator.operationalStatDate
+    puts operator.numberOfSubscribers
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get operator by id
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  operator = clx.get_operator_by_id(6)
+  puts operator.id
+  puts operator.name
+  puts operator.network
+  puts operator.uniqueName
+  puts operator.isoCountryCode
+  puts operator.operationalState
+  puts operator.operationalStatDate
+  puts operator.numberOfSubscribers
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get gateways
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  gateways = clx.get_gateways
+  gateways.each do |gateway|
+    puts gateway.id
+    puts gateway.name
+    puts gateway.type
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get gateway by id
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  gateway = clx.get_gateway_by_id(6)
+  puts gateway.id
+  puts gateway.name
+  puts gateway.type
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get price entires by gateway id
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  prices = clx.get_price_entires_by_gateway_id(6)
+  prices.each do |price|
+    puts price.price
+    puts price.gateway
+    puts price.operator
+    puts price.expireDate
+  end
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get price entry by gateway id and operator id
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  price = clx.get_price_entries_by_gateway_id_and_operator_id(6, 1)
+  puts price.price
+  puts price.gateway
+  puts price.operator
+  puts price.expireDate
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```
+## Get price entry by gateway id, operator id and date
+```ruby
+begin
+  clx = CLX::API.new('username', 'password')
+  date = DateTime.new(2015, 5, 25)
+  price = clx.get_price_entries_by_gateway_id_and_operator_id_and_date(6, 1, date)
+  puts price.price
+  puts price.gateway
+  puts price.operator
+  puts price.expireDate
+rescue CLX::CLXAPIException => e
+  puts e.clx_error_message
+  puts e.clx_error_code
+rescue CLX::CLXException => e
+  puts e.message
+rescue
+  puts 'other error'
+end
+```

data/lib/clx_api.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'clx_api/version'
+require 'clx_api/api'
+require 'clx_api/exceptions/clx_exception'
+require 'clx_api/exceptions/clx_api_exception'
+require 'clx_api/http_client'
+require 'clx_api/http_adapter'
+# Main namespace
+module CLX
+  # Module instance
+  class << self
+    # @!attribute [r]
+    attr_reader :base_url
+    # @!attribute [r]
+    attr_reader :paths
+    # REST server
+    def base_url
+      @base_url ||= 'https://clx-aws.clxnetworks.com/api'
+    end
+    # API paths hash
+    def paths
+      @paths ||= {
+        operator: '/operator',
+        gateway: '/gateway'
+      }
+    end
+  end
+end

clx_api 0.1.0