lunanode 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cb25dc43d07fe6725275b15c5b10a48d4b8c0e7
+  data.tar.gz: df01e9542eff9498a710ec7589d5b7d7474dbf31
+SHA512:
+  metadata.gz: e81cd909af5d0869cf64ef5892e616ca810f46ccc3d3e3ac87ece2cf325a065c3ce1ef95c689e6b617eef250e4fd4a39b244fd0c0751aaae0f595d12150324e0
+  data.tar.gz: 147833acf55cb3287e971dfac65b51b8ce6db2f7fb56bd85bee0b9d93821775e4b478cf8b1e5b444ae6dd410d4e48584806de15fc1bdd5927423a955e72d3718

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+       - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+   - "**.rb"
+exclude_paths:
+ - spec/

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.autoenv*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,94 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  DisplayCopNames: true
+
+# Metrics
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Reference: 'http://c2.com/cgi/wiki?AbcMetric'
+  Enabled: true
+  Max: 25
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
+  Enabled: true
+  Max: 4
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 250 lines of code.'
+  Enabled: true
+  Max: 250
+
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: true
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Enabled: true
+  Exclude:
+    - lib/lunanode/api_actions/default/*.rb
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 30 lines of code.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
+  Enabled: true
+  Max: 30
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 250 lines of code.'
+  Enabled: true
+  Max: 250
+
+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
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: true
+
+# Style
+Style/AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.ruby-gemset

@@ -0,0 +1 @@
+lunanode

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - 2.1.10
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler -v 1.14.3

data/.yardopts

@@ -0,0 +1 @@
+--exclude lib/lunanode/action_generator.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nomoon@phoebus.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lunanode_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tim Bellefleur
+
+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,50 @@
+# Lunanode
+
+[![Build Status](https://travis-ci.org/nomoon/lunanode.svg?branch=master)](https://travis-ci.org/nomoon/lunanode)
+[![Code Climate](https://codeclimate.com/github/nomoon/lunanode/badges/gpa.svg)](https://codeclimate.com/github/nomoon/lunanode)
+
+A basic implementation of the [Luna Node API](https://wiki.lunanode.com/index.php/API) for Ruby.
+**Unofficial and unsupported by the people at [Luna Node](https://lunanode.com).**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lunanode"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lunanode
+
+## Usage
+
+The class is instantiated by either passing it a JSON file containing the keys `api_id` and `api_key`, or specifying the ID and key directly:
+```
+  api = Lunanode::API.new("credentials_file.json")
+  api = Lunanode::API.new(api_id: "ABCDEFG", api_key: "HIJKLMNOP")
+```
+
+Once instantiated, action methods follow the example:
+
+```
+  api.vm_list # no parameters
+  api.vm_info(vm_id: "My-VM-ID") # required parameters
+  api.image_list(region: "Toronto") # optional parameters
+```
+
+More information is available in the documentation, available online at [rubydoc.info](http://www.rubydoc.info/github/nomoon/lunanode).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nomoon/lunanode. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Generates default actions modules from API spec YAML file."
+task :generate_default_api_modules do
+  require "lunanode/action_generator"
+  modules = Lunanode::ActionGenerator.generate_default_modules
+  modules.each do |category, module_s|
+    filename = "lib/lunanode/api_actions/default/#{category}.rb"
+    raise "File already exists: #{filename}" if File.exist?(filename)
+    bytes = File.write(filename, module_s)
+    puts "File written: #{filename} (#{bytes} bytes)"
+  end
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lunanode"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lunanode.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "lunanode/version"
+require "lunanode/api_actions"
+require "lunanode/api_error"
+require "lunanode/api"
+
+# Namespace for classes and modules in the Lunanode API gem
+#
+# See {Lunanode::API} for usage information.
+module Lunanode
+end

data/lib/lunanode/action_generator.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Lunanode
+  # Helper utility to generate ruby source module/method definitions for API
+  # actions from a YAML file.
+  #
+  # It is not required by default and does not evaluate source. (See Rakefile.)
+  module ActionGenerator
+    module_function
+
+    def api_data
+      @api_data ||= YAML.safe_load(
+        File.read("lunanode_api_def.yaml"),
+        [String, Symbol]
+      )
+    end
+
+    def generate_default_modules
+      generate_categories(api_data)
+    end
+
+    UNSAFE_IDENTIFIER = /.{21,}|[^A-Za-z0-9_*]/
+
+    def module_name(name)
+      if name.length > 3
+        name.capitalize
+      else
+        name.upcase
+      end
+    end
+
+    def indent_lines(string)
+      string.gsub(/^(?!$)/, "  ")
+    end
+
+    def check_safe!(identifier)
+      raise "Unsafe name `#{identifier}`" if identifier =~ UNSAFE_IDENTIFIER
+    end
+
+    def generate_categories(data)
+      (data.map do |category, actions|
+        check_safe!(category)
+        [category, generate_actions(category, actions)]
+      end).to_h
+    end
+
+    def generate_actions(category, actions)
+      actions = actions.map do |action, params|
+        generate_action(category, action, params)
+      end
+
+      category_module = "module #{module_name(category)}\n" +
+                        actions.map { |a| indent_lines(a) }.join("\n") +
+                        "end\n"
+
+      actions_module = "module APIActions\n" +
+                       indent_lines(category_module) +
+                       "end\n"
+
+      src = "module #{name.split('::')[-2]}\n" +
+            indent_lines(actions_module) +
+            "end\n"
+
+      "# frozen_string_literal: true\n\n#{src}"
+    end
+
+    def generate_action(category, action, params)
+      check_safe!(action)
+      params = params.to_h
+
+      param_list_req = Array(params[:required])
+      param_list_opt = Array(params[:optional])
+      param_list = param_list_req + param_list_opt
+      param_list.each { |p| check_safe!(p) }
+
+      param_list_call_arr = param_list.map do |p|
+        p.start_with?("**") ? p : "#{p}: #{p}"
+      end
+
+      param_list_req_sig_arr = param_list_req.map do |p|
+        "#{p}:"
+      end
+
+      param_list_opt_sig_arr = param_list_opt.map do |p|
+        p.start_with?("**") ? p : "#{p}: nil"
+      end
+      param_list_sig_arr = (param_list_req_sig_arr + param_list_opt_sig_arr)
+
+      unless param_list.empty?
+        param_list_call = ", #{param_list_call_arr.join(', ')}"
+        param_list_sig = "(#{param_list_sig_arr.join(', ')})"
+      end
+
+      "def #{category}_#{action}#{param_list_sig}\n" \
+      "  action(:#{category}, :#{action}#{param_list_call})\n" \
+      "end\n"
+    end
+
+    private_constant :UNSAFE_IDENTIFIER
+    private_class_method :check_safe!, :generate_categories, :generate_actions,
+                         :generate_action
+  end
+end