limited-salt-api 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53f64d5a561fcf4ce8fa2fb783fa3a1282b206dcd5435473c31bf2f89c84c22d
+  data.tar.gz: d859fce62748dbddba2d5a4a9b1f78d3736952823c179166422a277ef43391ba
+SHA512:
+  metadata.gz: b4cce2f52f80f4bc3b4724a64f70ab6ddd539307fcb4667461899ea429c088c993669036005a7925aeee2f86fe249a8bc9bf18481011b2d2aed12cbcf243e4fc
+  data.tar.gz: a58d474660329fcb4c24ea5a58df6a5e88febd84251760e5a5689a08dac3db51987701c627a6084ae79bee6441087e5bdcc85ad400fa7096e8f6584f64d1d412

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in limited-salt-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joshua Bussdieker
+
+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,62 @@
+# Salt API
+
+This is a simple client gem for the Salt API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salt-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salt-api
+
+## Usage
+
+Get a list of minions including grains info.
+
+```
+require 'salt/api'
+
+Salt::Api.configure do |config|
+  config.hostname = "salt.example.com"
+  config.username = "user1"
+  config.password = "password"
+  config.eauth = "ldap"
+end
+
+puts Salt::Api.minions
+```
+
+```
+require 'salt/api'
+
+Salt::Api.run(
+  client: 'local',
+  tgt: '*',
+  fun: 'test.ping'
+)
+```
+
+## 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/jbussdieker/ruby-salt-api.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "salt/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/salt/api.rb

@@ -0,0 +1,18 @@
+require "salt/api/version"
+require "salt/api/configure"
+require "salt/api/client"
+require "salt/api/minions"
+require "salt/api/events"
+require "salt/api/run"
+require "salt/api/jobs"
+
+module Salt
+  module Api
+    extend Configure
+    extend Client
+    extend Minions
+    extend Events
+    extend Run
+    extend Jobs
+  end
+end

data/lib/salt/api/client.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'yaml'
+
+module Salt
+  module Api
+    module Client
+      def client
+        Net::HTTP.new(hostname, port).tap do |client|
+          client.use_ssl = use_ssl
+          client.open_timeout = timeout
+          client.read_timeout = read_timeout
+          # TODO: Allow specifying CA and such
+          client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+
+      def login
+        req = Net::HTTP::Post.new("/login")
+        req.set_form_data({
+          'eauth' => eauth,
+          'username' => username,
+          'password' => password
+        })
+        req['Accept'] = "application/x-yaml"
+        resp = client.request(req)
+        raise "Login failed" unless resp.kind_of? Net::HTTPSuccess
+        parsed_resp = YAML.load(resp.body)["return"]
+        raise "Multiple results? (#{parsed_resp.inspect})" if parsed_resp.length > 1
+        parsed_resp.first
+      end
+
+      def token
+        login["token"]
+      end
+    end
+  end
+end

data/lib/salt/api/configure.rb

@@ -0,0 +1,30 @@
+module Salt
+  module Api
+    module Configure
+      VALID_OPTION_KEYS = [
+        :hostname,
+        :username,
+        :password,
+        :timeout,
+        :read_timeout,
+        :eauth,
+        :port,
+        :use_ssl
+      ].freeze
+
+      attr_accessor *VALID_OPTION_KEYS
+
+      def set_defaults
+        @hostname = "salt"
+        @port = 8000
+        @use_ssl = true
+        @eauth = 'pam'
+      end
+
+      def configure
+        set_defaults
+        yield self
+      end
+    end
+  end
+end

data/lib/salt/api/events.rb

@@ -0,0 +1,38 @@
+require 'json'
+
+module Salt
+  module Api
+    module Events
+      def events(&block)
+        buffer = ""
+        raw_events do |data|
+          buffer += data
+
+          while buffer.match("\n")
+            event, buffer = buffer.split("\n", 2)
+            if event.start_with? "data: "
+              yield(JSON.parse(event.split("data: ", 2).last))
+            end
+          end
+        end
+      end
+
+      private
+
+      def raw_events(&block)
+        req = Net::HTTP::Get.new("/events")
+        req['X-Auth-Token'] = token
+        req['Accept'] = "application/x-yaml"
+        client.request(req) do |response|
+          raise "Get request to /events failed (#{response})" unless response.kind_of? Net::HTTPSuccess
+
+          response.read_body do |chunk|
+            yield(chunk)
+          end
+        end
+      rescue Errno::ETIMEDOUT, Net::OpenTimeout => e
+        e
+      end
+    end
+  end
+end

data/lib/salt/api/jobs.rb

@@ -0,0 +1,15 @@
+module Salt
+  module Api
+    module Jobs
+      def jobs(jid = nil)
+        req = Net::HTTP::Get.new(jid.nil? ? "/jobs" : "/jobs/#{jid}")
+        req['X-Auth-Token'] = token
+        req['Accept'] = "application/x-yaml"
+        resp = client.request(req)
+        raise "Get request to /jobs failed (#{resp})" unless resp.kind_of? Net::HTTPSuccess
+        parsed_resp = YAML.load(resp.body)["return"]
+        return parsed_resp
+      end
+    end
+  end
+end

data/lib/salt/api/minions.rb

@@ -0,0 +1,16 @@
+module Salt
+  module Api
+    module Minions
+      def minions
+        req = Net::HTTP::Get.new("/minions")
+        req['X-Auth-Token'] = token
+        req['Accept'] = "application/x-yaml"
+        resp = client.request(req)
+        raise "Get request to /minions failed (#{resp})" unless resp.kind_of? Net::HTTPSuccess
+        parsed_resp = YAML.load(resp.body)["return"]
+        raise "Multiple results? (#{parsed_resp.inspect})" if parsed_resp.length > 1
+        parsed_resp.first
+      end
+    end
+  end
+end

data/lib/salt/api/run.rb

@@ -0,0 +1,19 @@
+module Salt
+  module Api
+    module Run
+      def run(args)
+        req = Net::HTTP::Post.new("/")
+        req['X-Auth-Token'] = token
+        req['Accept'] = "application/x-yaml"
+        req['Content-Type'] = "application/json"
+        req.body = args.to_json
+        
+        resp = client.request(req)
+        raise "Get request to /run failed (#{resp})" unless resp.kind_of? Net::HTTPSuccess
+        parsed_resp = YAML.load(resp.body)["return"]
+        raise "Multiple results? (#{parsed_resp.inspect})" if parsed_resp.length > 1
+        parsed_resp.first
+      end
+    end
+  end
+end

data/lib/salt/api/version.rb

@@ -0,0 +1,5 @@
+module Salt
+  module Api
+    VERSION = "0.1.7"
+  end
+end

data/salt-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salt/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "limited-salt-api"
+  spec.version       = Salt::Api::VERSION
+  spec.authors       = ["jkerry"]
+  spec.email         = ["john@kerryhouse.net"]
+
+  spec.summary       = %q{a salt api gem forked from ruby-salt-api.}
+  spec.homepage      = "https://github.com/jkerry/ruby-salt-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |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_dependency "json"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: limited-salt-api
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- jkerry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-22 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: json
+  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: 
+email:
+- john@kerryhouse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/salt/api.rb
+- lib/salt/api/client.rb
+- lib/salt/api/configure.rb
+- lib/salt/api/events.rb
+- lib/salt/api/jobs.rb
+- lib/salt/api/minions.rb
+- lib/salt/api/run.rb
+- lib/salt/api/version.rb
+- salt-api.gemspec
+homepage: https://github.com/jkerry/ruby-salt-api
+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.7.6
+signing_key: 
+specification_version: 4
+summary: a salt api gem forked from ruby-salt-api.
+test_files: []