internode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dee6dad4185b3955b4e8861685ae028e7408232f
+  data.tar.gz: 493e9b948165a5dd76fadbe9ba6fd6053b66327f
+SHA512:
+  metadata.gz: b0f45b140ebcf0190fc4de362425b1909f112ae8698c48a32c5d2c466c15b89a78be44182ec8a61cd6071c3296764c60c7d825fbe6af1a464d1d37106575fd9a
+  data.tar.gz: ba93a08825d8ba959eeb057183bcc02f24697d5a59ed900c4d7bcd4258afbe882bf307ed3c3b94f5a199312478f3f129d3e3932ffba680765f39e257ff9fe68c

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    internode (1.0.0)
+      httpclient
+      oga
+      table_print
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    ansi (1.5.0)
+    ast (2.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    httpclient (2.6.0.1)
+    oga (1.2.1)
+      ast
+      ruby-ll (~> 2.1)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    ruby-ll (2.1.2)
+      ansi
+      ast
+    safe_yaml (1.0.4)
+    table_print (1.5.4)
+    thor (0.19.1)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  internode!
+  rake (~> 10.0)
+  rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marty Zalega
+
+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,86 @@
+# Internode Ruby Client
+
+This is an unofficial ruby client for Internode's usage and account API. A CLI is also included as a convenient way to retrieve information via the command line.
+
+**Note** At time of writing Internode's API is unstable, 500ing quote often. This is not an issue with the client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'internode'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install internode
+
+## Usage
+
+```ruby
+require "internode"
+
+account = Internode::Account.new(
+  username: "<account username>",
+  password: "<account password>"
+)
+
+# Get all the services for the account
+account.services
+
+service = account.services.first
+
+# Get service plan
+service.details.plan
+
+# Get service speed (as string)
+service.details.speed
+
+# Get rollover date (as string)
+service.details.rollover
+
+# Get plan interval (usually monthly)
+service.details.plan_interval
+
+# Get plan cost (as string)
+service.details.plan_cost
+
+# Get service quota
+service.usage.quota    # in bytes
+service.usage.quota_mb # in megabytes, not mebibytes
+service.usage.quota_gb # in gigabytes, not gibibytes
+
+# Get service total usage
+service.usage.total    # in bytes
+service.usage.total_mb # in megabytes, not mebibytes
+service.usage.total_gb # in gigabytes, not gibibytes
+
+# Get percentage used
+service.usage.percentage
+
+# Get all details for the services
+account.details # Same as account.services.map(&:details)
+
+# Get all usage information for the services
+account.usage # Same as account.services.map(&:usage)
+```
+
+## TODO
+
+* Add support for service history
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evilmarty/internode.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/internode

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path("../../lib", __FILE__)
+
+require "internode/cli"
+
+Internode::CLI.start(ARGV)

data/internode.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'internode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "internode"
+  spec.version       = Internode::VERSION
+  spec.authors       = ["Marty Zalega"]
+  spec.email         = ["marty@zalega.me"]
+
+  spec.summary       = %q{Internode Ruby client}
+  spec.description   = %q{A ruby client for Internode's API}
+  spec.homepage      = "https://github.com/evilmarty/internode.rb"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "httpclient"
+  spec.add_dependency "oga"
+  spec.add_dependency "table_print"
+  spec.add_dependency "thor"
+end

data/lib/internode/account.rb

@@ -0,0 +1,34 @@
+module Internode
+  class Account < Resource
+    PATH = "/api/v1.5"
+
+    def initialize(options = {})
+      client = options.fetch(:client){ Client.new(username: options[:username], password: options[:password]) }
+      path = options.fetch(:path){ PATH }
+      super(client: client, path: path)
+    end
+
+    def services
+      @services ||= content.css("services service").map do |node|
+        Service.new(client: client, path: node.attr("href").text)
+      end
+    end
+
+    def details
+      concurrent_map(&:details)
+    end
+
+    def usage
+      concurrent_map(&:usage)
+    end
+
+  private
+
+    # Used to allow performing API requests in parallal instead of series
+    def concurrent_map
+      threads = services.map{|s| Thread.new{ yield s } }
+      threads.each(&:join)
+      threads.map(&:value)
+    end
+  end
+end

data/lib/internode/cli.rb

@@ -0,0 +1,40 @@
+require "internode"
+require "table_print"
+require "thor"
+
+module Internode
+  class CLI < Thor
+    class_option :user, aliases: :u
+    class_option :password, aliases: :p
+    class_option :human, aliases: :h, type: :boolean
+
+    desc "list", "List services"
+    def list
+      tp account.details, :id, :type, :plan, format(:quota), :speed
+    rescue Client::ServerError => err
+      print_error(err)
+    end
+
+    desc "usage", "Show usage for service"
+    def usage
+      tp account.usage, :id, :type, format(:total), format(:quota), :percentage, :plan_interval, :rollover
+    rescue Client::ServerError => err
+      print_error(err)
+    end
+
+  private
+
+    def format(name)
+      options[:human] ? :"#{name}_gb" : name
+    end
+
+    def account
+      Account.new(username: options[:user], password: options[:password])
+    end
+
+    def print_error(error)
+      puts "Internode: #{error}"
+      exit 128
+    end
+  end
+end

data/lib/internode/client.rb

@@ -0,0 +1,29 @@
+require "httpclient"
+require "oga"
+
+module Internode
+  class Client
+    URL = "https://customer-webtools-api.internode.on.net"
+
+    class ServerError < RuntimeError; end
+
+    def initialize(options = {})
+      username = options.fetch(:username){ ENV["INTERNODE_USERNAME"] }
+      password = options.fetch(:password){ ENV["INTERNODE_PASSWORD"] }
+      @url = options.fetch(:url){ URL }
+      @client = HTTPClient.new
+      @client.set_auth(@url, username, password)
+      @client.cookie_manager = nil
+    end
+
+    def get(path, *args)
+      url = "#{@url}#{path}"
+      content = @client.get_content(url)
+
+      Oga.parse_xml(content).at_css("internode api")
+
+    rescue HTTPClient::BadResponseError => err
+      raise ServerError.new("#{err.res.status_code} #{err.res.reason}")
+    end
+  end
+end

data/lib/internode/details.rb

@@ -0,0 +1,22 @@
+module Internode
+  class Details < Resource
+    content_attr :id, :username, :plan, :carrier, :speed
+    content_attr "usage-rating", "rollover", "excess-charged", "excess-shaped", "excess-restrict-access", "plan-interval", "plan-cost"
+
+    def type
+      content.at_css("service").attr("type").text
+    end
+
+    def quota
+      content.at_css("quota").text.to_i
+    end
+
+    def quota_mb
+      quota / 1000 / 1000
+    end
+
+    def quota_gb
+      quota_mb / 1000
+    end
+  end
+end

data/lib/internode/resource.rb

@@ -0,0 +1,27 @@
+module Internode
+  class Resource
+    attr_reader :path, :client
+
+    def initialize(options = {})
+      @client = options.fetch(:client){ Internode.client }
+      @path = options[:path]
+    end
+
+    def content
+      @content ||= @client.get(path)
+    end
+
+    class << self
+      def content_attr(*names)
+        names.each do |name|
+          name = name.to_s
+          method_name = name.gsub(/\W+/, "_")
+
+          define_method(method_name) do
+            content.at_css(name).text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/internode/service.rb

@@ -0,0 +1,33 @@
+module Internode
+  class Service < Resource
+    def id
+      service.text
+    end
+
+    def type
+      service.attr("type").text
+    end
+
+    def details
+      @details ||= Details.new(client: client, path: details_path)
+    end
+
+    def usage
+      @usage ||= Usage.new(client: client, path: usage_path)
+    end
+
+  private
+
+    def service
+      @service ||= content.at_css("service")
+    end
+
+    def details_path
+      content.at_css("resource[type='service']").attr("href").text
+    end
+
+    def usage_path
+      content.at_css("resource[type='usage']").attr("href").text
+    end
+  end
+end

data/lib/internode/usage.rb

@@ -0,0 +1,57 @@
+module Internode
+  class Usage < Resource
+    def id
+      service.text
+    end
+
+    def type
+      service.attr("type").text
+    end
+
+    def total
+      traffic.text.to_i
+    end
+
+    def total_mb
+      total / 1000 / 1000
+    end
+
+    def total_gb
+      total_mb / 1000
+    end
+
+    def rollover
+      traffic.attr("rollover").text
+    end
+
+    def plan_interval
+      traffic.attr("plan-interval").text
+    end
+
+    def quota
+      traffic.attr("quota").text.to_i
+    end
+
+    def quota_mb
+      quota / 1000 / 1000
+    end
+
+    def quota_gb
+      quota_mb / 1000
+    end
+
+    def percentage
+      total.to_f / quota.to_f * 100.0
+    end
+
+  private
+
+    def service
+      @service ||= content.at_css("service")
+    end
+
+    def traffic
+      @traffic ||= content.at_css("traffic")
+    end
+  end
+end

data/lib/internode/version.rb

@@ -0,0 +1,3 @@
+module Internode
+  VERSION = "1.0.0"
+end

data/lib/internode.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bundler/setup"
+
+require "internode/version"
+
+module Internode
+  autoload :Account,  "internode/account"
+  autoload :Client,   "internode/client"
+  autoload :Details,  "internode/details"
+  autoload :Resource, "internode/resource"
+  autoload :Service,  "internode/service"
+  autoload :Usage,    "internode/usage"
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.client=(client)
+    @client = client
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: internode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marty Zalega
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: vcr
+  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: httpclient
+  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: oga
+  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: table_print
+  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: thor
+  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'
+description: A ruby client for Internode's API
+email:
+- marty@zalega.me
+executables:
+- internode
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/internode
+- internode.gemspec
+- lib/internode.rb
+- lib/internode/account.rb
+- lib/internode/cli.rb
+- lib/internode/client.rb
+- lib/internode/details.rb
+- lib/internode/resource.rb
+- lib/internode/service.rb
+- lib/internode/usage.rb
+- lib/internode/version.rb
+homepage: https://github.com/evilmarty/internode.rb
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Internode Ruby client
+test_files: []