lunanode 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4a86afa70afc9876d468543733644a5d6250c43
-  data.tar.gz: 653e08f16c13c01829deda1e1193a99b6a85d394
+  metadata.gz: e34a9df27d3a00d606d1de48db6eb9bbf2f2c403
+  data.tar.gz: f2937c563d7e2ce7ac80a8f12e77ca8223a8643d
 SHA512:
-  metadata.gz: ecb1f25922f283901cd4a2c97d17feda5754b8c9858f57d3bf1a5678be512e38ca534c366d995c16c1937e2fb172ea8c48939b8ba8f7478d99c54185f3e3327c
-  data.tar.gz: 989713bca6baddc11020910e6a982cc98ddb0415ca2071b239b99af6ab573631ffd71b5ba5bd73bacc4ce1967a6d0a7b2d016609cc214ef2e1742cd58a5367b1
+  metadata.gz: 70914da6f5a7bc35141a03338abd3f98cc81179413d2d4ceb687bcd89cc2ec689332be581e539c98fd4936b27ef773d2003cbf68785aaf784a92a40bf425f7fd
+  data.tar.gz: 2bd8e4a9053eb640dd53b0ee359f4be4eb0fe608afc8d3cdfc760aa5e73ed08a4a8d953b3948141f8d8ce30866ffba5a0b459f8edc1f9b6655b5bfd407596291

data/.rubocop.yml

@@ -50,7 +50,8 @@ Metrics/ParameterLists:
   Description: 'Avoid parameter lists longer than three or four parameters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
   Enabled: true
-  Max: 13
+  Max: 4
+  CountKeywordArgs: false
 
 Metrics/PerceivedComplexity:
   Description: >-

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.2.0]
+### Added
+- Created this Changelog.
+- API calls will now print potentially-useful information if $DEBUG=true
+
+### Changed
+- Improved documentation (particularly for `API.new` and `API.params_for`).
+- `API.new` will no longer instantiate without any parameters, though it is less
+  fussy about its parameters now.
+- APIError now unescapes some HTML entities from the provided message for
+improved readability.
+- APIError will also pretty-print JSON responses.
+
+## [0.1.6] - 2017-02-08
+### Changed
+- Minor README improvements.
+
+### Fixed
+- Action names with hyphens were broken. The methods still use underscores
+instead, but the proper hyphenated names are sent to the API.
+
+## [0.1.5] - 2017-02-07
+First public release.
+
+### Changed
+- Almost everything. Reorganized layout of gem to prepare for actual release.
+This is the first point of reasonable functionality/stability.
+
+## [0.0.1] - 2017-02-07
+### Added
+- Initial commit, not publicly released
+
+[Unreleased]: https://github.com/nomoon/lunanode/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/nomoon/lunanode/compare/v0.1.6...v0.2.0
+[0.1.6]: https://github.com/nomoon/lunanode/compare/v0.1.5...v0.1.6
+[0.1.5]: https://github.com/nomoon/lunanode/compare/v0.0.1...v0.1.5
+[0.0.1]: https://github.com/nomoon/lunanode/releases/tag/v0.0.1

data/lib/lunanode/api.rb

@@ -28,28 +28,24 @@ module Lunanode
     API_ENDPOINT = "https://dynamic.lunanode.com/api/".freeze
     @params_for = {}
 
-    # Show parameter info for any API method.
+    # Show parameter info for any {API} instance method.
     #
-    # @param method_name[#to_sym] The name of the API method
-    # @return [Hash] information about the method parameters
+    # The keys of the hash results denote the type of parameter:
+    # - :keyreq  => Required keyword argument
+    # - :key     => Optional keyword argument
+    # - :keyrest => Arbitrary additional keyword arguments
+    # - :req     => Required positional argument
+    # - :opt     => Optional positional argument
+    # - :rest    => Arbitrary additional positional arguments
     #
+    # @param method_name[#to_sym] The name of the API method
+    # @return [Hash] information about the method parameters.
     def self.params_for(method_name)
       @params_for[method_name] ||= begin
         method_name = method_name.to_sym
         param_groups = instance_method(method_name).parameters.group_by(&:first)
-        out = {
-          required: param_groups[:keyreq] && param_group[:keyreq].map(&:last),
-          optional: param_groups[:key] && param_groups[:key].map(&:last),
-          additional: param_groups.key?(:keyrest),
-        }
-        out.each do |k, v|
-          if v
-            v.freeze
-          else
-            out.delete(k)
-          end
-        end
-        out.freeze
+        out = param_groups.map { |k, v| [k, v.map(&:last)] }.to_h
+        out.each_value(&:freeze).freeze
       end
     end
 
@@ -60,28 +56,33 @@ module Lunanode
     include APIActions
     attr_reader :api_id
 
+    # Instantiate an API object
+    #
+    # @return [API] an API instance.
+    #
     # @overload initialize(credentials_file)
     #   Instantiate an API object from a credentials file.
-    #   @param credentials_file[IO,String] a JSON credentials file
+    #   @param credentials_file[String,File] a JSON credentials file
     #     (which contains the keys `api_id` and `api_key`)
     #
-    # @overload initialize(api_id: nil, api_key: nil)
+    #   @raise [JSON::ParserError] if the JSON file could not be read properly.
+    #   @raise [KeyError] if any required key could not be found.
+    #
+    # @overload initialize(api_id: , api_key: )
     #   Instantiate an API object from an API ID and API Key.
     #   @param api_id[String] A LunaNode API ID
     #   @param api_key[String] A LunaNode API Key
     #
-    def initialize(credentials_file = nil, api_id: nil, api_key: nil)
-      if !credentials_file.nil? && File.exist?(credentials_file)
+    #   @raise [KeyError] if any required key could not be found.
+    #
+    def initialize(*args, **options)
+      credentials_file = args.compact.first.to_s
+      if File.exist?(credentials_file)
         credentials_data = File.read(credentials_file)
-        credentials = JSON.parse(credentials_data, symbolize_names: true)
-        @api_id = credentials[:api_id]
-        @api_key = credentials[:api_key]
-      else
-        @api_id = api_id
-        @api_key = api_key
+        options = JSON.parse(credentials_data, symbolize_names: true)
       end
-      @api_id = @api_id.to_s.freeze
-      @api_key = @api_key.to_s.freeze
+      @api_id = options.fetch(:api_id).to_s.dup.freeze
+      @api_key = options.fetch(:api_key).to_s.dup.freeze
       @rest_client = RestClient::Resource.new(
         API_ENDPOINT,
         verify_ssl: OpenSSL::SSL::VERIFY_PEER
@@ -98,7 +99,7 @@ module Lunanode
     #
     # @param category[#to_sym] The API action category (i.e. dns, image, vm...)
     # @param action[#to_sym] The API action name (i.e. create, list...)
-    # @param params[Hash] Any parameters required for the action.
+    # @param params[**Hash] Any parameters required for the action.
     #
     # @return [Hash,Array,String] Response data from the API action.
     # @raise [APIError] If there was a problem with the action.
@@ -122,6 +123,14 @@ module Lunanode
     # Make an API call and return response.
     def call_api(handler_path, params)
       req_formdata = auth_request_formdata(handler_path, clean_params(params))
+      if $DEBUG
+        STDERR.puts "call_api()\n" + JSON.pretty_generate(
+          path: "#{rest_client.url}#{handler_path}",
+          req: JSON.parse(req_formdata[:req]),
+          signature: req_formdata[:signature],
+          nonce: req_formdata[:nonce]
+        )
+      end
       JSON.parse(rest_client[handler_path].post(req_formdata),
                  symbolize_names: true)
     rescue RestClient::Exception => err
@@ -155,7 +164,7 @@ module Lunanode
     def raw_request_message(params)
       params[:api_id] = api_id
       params[:api_partialkey] = api_key.slice(0, 64)
-      params.to_json
+      JSON.generate(params)
     end
 
     # Generate nonce for request

data/lib/lunanode/api_error.rb

@@ -1,5 +1,16 @@
+# frozen_string_literal: true
+require "cgi"
+require "json"
+
 module Lunanode
   # A RuntimeError raised when the API call returns unsuccessfully.
   class APIError < RuntimeError
+    def to_s
+      unescaped = CGI.unescapeHTML(super)
+      return unescaped unless unescaped.start_with?("\"{")
+      JSON.pretty_generate(JSON.parse(unescaped.gsub(/\A"|"\z/, "")))
+    rescue JSON::ParserError
+      unescaped
+    end
   end
 end

data/lib/lunanode/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Lunanode
-  VERSION = "0.1.6".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lunanode
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Bellefleur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -123,6 +123,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt