fluffy-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5293108ca23502a00f4b6692fc74e9ee94c6a449
+  data.tar.gz: 5af10d47249e648805cd4f558868cee181518e35
+SHA512:
+  metadata.gz: 9c1ac80ca83f6f1bccad05ed5fe7b1356e8974553674f3e098db7af75886746d09c3d98ee16113881fc778e8a8d870ddec3aea05f801bc6ef24d71e5442d5a1e
+  data.tar.gz: 068f82d4fcdcddd8bb6313ad7de89df9010e1c458ded93c2f0604c41591ca22579fa402032c29612dc42ec96fe2cae978c3f17b6148fa9d1b5d3a85fd9bb9760

data/LICENSE

@@ -0,0 +1,12 @@
+ Copyright 2017 Matteo Cerutti
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/README.md

@@ -0,0 +1,12 @@
+# Ruby client library for Fluffy REST API
+This is a simple Ruby client library that allows to interact with the Fluffy REST API.
+
+## Install
+To install it simply issue the following command:
+
+```
+gem install fluffy-ruby
+```
+
+## Contact
+Matteo Cerutti - matteo.cerutti@hotmail.co.uk

data/lib/fluffy/api.rb

@@ -0,0 +1,56 @@
+module Fluffy
+  module API
+    @@api = nil
+
+    def self.api
+      @@api
+    end
+
+    # @return [HTTPClient] HTTP client instance
+    attr_reader :http
+    # @return [String] Fluffy REST API's URL
+    attr_reader :url
+
+    # Create a Fluffy Client API object
+    #
+    # @param url [String] Fluffy REST API's URL
+    #
+    def initialize(url:)
+      @http = HTTPClient.new
+      @url = url
+    end
+
+    # Perform a HTTP GET request
+    #
+    # @param endpoint [Array[String], String] HTTP API endpoint
+    # @param query [String] HTTP API query parameters
+    # @return [Array[Hash], Hash] API JSON response
+    #
+    def get(endpoint:, query: nil)
+      resp = self.http.get([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), query, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(resp.body)
+    end
+
+    # Perform a HTTP POST request
+    #
+    # @param endpoint [Array[String], String] HTTP API endpoint
+    # @param params [Hash] HTTP API body
+    # @return [Hash, nil] API JSON response
+    #
+    def post(endpoint:, params: {})
+      puts [self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/')
+      resp = self.http.post([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), params.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(resp.body)
+    end
+
+    # Perform a HTTP DELETE request
+    #
+    # @param endpoint [Array[String], String] HTTP API endpoint
+    # @return [Hash, nil] API JSON response
+    #
+    def delete(endpoint:)
+      resp = self.http.delete([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(resp.body)
+    end
+  end
+end

data/lib/fluffy/client.rb

@@ -0,0 +1,66 @@
+require 'httpclient'
+require 'json'
+
+require_relative 'client/api'
+require_relative 'sessions'
+
+module Fluffy
+  class Client
+    include Fluffy::API
+
+    # @return [Fluffy::Sessions] Sessions instance
+    attr_reader :sessions
+
+    # Create a new client
+    #
+    # @param url [String] Fluffy REST API's URL
+    # @param version [Integer] API version (defaults to `1`)
+    #
+    def initialize(url:, version: 1)
+      @url = url
+      @version = version
+      @@api = API.new(url: URI.join(url, "v#{version}"))
+      @sessions = Sessions.new
+    end
+
+    # Retrieve the active addressbook
+    #
+    # @return [Hash] List of addresses
+    #
+    def addressbook
+      @@api.get(endpoint: "addressbook")
+    end
+
+    # Retrieve the active rules
+    #
+    # @return [Hash] List of rules
+    #
+    def rules
+      @@api.get(endpoint: "rules")
+    end
+
+    # Retrieve the active chains
+    #
+    # @return [Hash] List of chains
+    #
+    def chains
+      @@api.get(endpoint: "chains")
+    end
+
+    # Retrieve the active interfaces
+    #
+    # @return [Hash] List of interfaces
+    #
+    def interfaces
+      @@api.get(endpoint: "interfaces")
+    end
+
+    # Retrieve the active services
+    #
+    # @return [Hash] List of services
+    #
+    def services
+      @@api.get(endpoint: "services")
+    end
+  end
+end

data/lib/fluffy/session.rb

@@ -0,0 +1,64 @@
+require_relative 'session/addressbook'
+require_relative 'session/services'
+require_relative 'session/rules'
+require_relative 'session/interfaces'
+require_relative 'session/chains'
+
+module Fluffy
+  class Session
+    include Fluffy::API
+
+    # @return [Fluffy::Session::Addressbook] The session addressbook
+    attr_reader :addressbook
+    # @return [Fluffy::Session::Services] The session services
+    attr_reader :services
+    # @return [Fluffy::Session::Rules] The session rules
+    attr_reader :rules
+    # @return [Fluffy::Session::Interfaces] The session interfaces
+    attr_reader :interfaces
+    # @return [Fluffy::Session::Chains] The session chains
+    attr_reader :chains
+    # @return [String] The session endpoint
+    attr_reader :endpoint
+
+    # Create a new session
+    #
+    # @param name [String] Session name
+    # @param owner [String] Session owner
+    # @param ttl [Integer] Session time-to-live
+    #
+    def initialize(name:, owner:, ttl:)
+      @endpoint = ["sessions", name]
+
+      # create session
+      @@api.post(endpoint: @endpoint, params: {'owner' => owner, 'ttl' => ttl})
+
+      @addressbook = Addressbook.new(endpoint: @endpoint)
+      @services = Services.new(endpoint: @endpoint)
+      @rules = Rules.new(endpoint: @endpoint)
+      @interfaces = Interfaces.new(endpoint: @endpoint)
+      @chains = Chains.new(endpoint: @endpoint)
+    end
+
+    # Commit the session configuration
+    #
+    # @param rollback [Boolean] Enable rollback `defaults to false`
+    # @param rollback_interval [Integer] Rollback configuration at the given interval (seconds) `defaults to 60`
+    #
+    def commit!(rollback: true, rollback_interval: 60)
+      @@api.post(endpoint: self.endpoint + ['commit'], params: params)
+    end
+
+    # Confirm the session configuration
+    #
+    def confirm!
+      @@api.post(endpoint: self.endpoint + ['confirm'])
+    end
+
+    # Destroy the session
+    #
+    def destroy!
+      @@api.delete(endpoint: self.endpoint)
+    end
+  end
+end

data/lib/fluffy/session/addressbook.rb

@@ -0,0 +1,57 @@
+require_relative '../api'
+
+module Fluffy
+  class Session
+    class Addressbook
+      include Fluffy::API
+
+      # @return [String] The session endpoint
+      attr_reader :endpoint
+
+      # Create an addressbook instance for a given session
+      #
+      # @param endpoint [String] API session endpoint
+      #
+      def initialize(endpoint:)
+        @endpoint = endpoint + ['addressbook']
+      end
+
+      # Retrieve the session addressbook
+      #
+      # @return [Hash] The session addressbook
+      #
+      def get
+        @@api.get(endpoint: self.endpoint)
+      end
+
+      # Add a new entry in the session addressbook
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def add(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Update an existing entry in the session addressbook
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def update(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Delete an entry from the session addressbook
+      #
+      # @param name [String] Entry name
+      # @return [Hash, nil] API response
+      #
+      def delete(name:)
+        @@api.delete(endpoint: self.endpoint + [name])
+      end
+    end
+  end
+end

data/lib/fluffy/session/chains.rb

@@ -0,0 +1,55 @@
+module Fluffy
+  class Session
+    class Chains
+      include Fluffy::API
+
+      # @return [String] The session endpoint
+      attr_reader :endpoint
+
+      # Create a chains instance for a given session
+      #
+      # @param endpoint [String] API session endpoint
+      #
+      def initialize(endpoint:)
+        @endpoint = endpoint + ['chains']
+      end
+
+      # Retrieve the session chains
+      #
+      # @return [Hash] The session chains
+      #
+      def get
+        @@api.get(endpoint: self.endpoint)
+      end
+
+      # Add a new entry in the session chains
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def add(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Update an existing entry in the session chains
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def update(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Delete an entry from the session chains
+      #
+      # @param name [String] Entry name
+      # @return [Hash, nil] API response
+      #
+      def delete(name:)
+        @@api.delete(endpoint: self.endpoint + [name])
+      end
+    end
+  end
+end

data/lib/fluffy/session/interfaces.rb

@@ -0,0 +1,55 @@
+module Fluffy
+  class Session
+    class Interfaces
+      include Fluffy::API
+
+      # @return [String] The session endpoint
+      attr_reader :endpoint
+
+      # Create an interfaces instance for a given session
+      #
+      # @param endpoint [String] API session endpoint
+      #
+      def initialize(endpoint:)
+        @endpoint = endpoint + ['interfaces']
+      end
+
+      # Retrieve the session interfaces
+      #
+      # @return [Hash] The session interfaces
+      #
+      def get
+        @@api.get(endpoint: self.endpoint)
+      end
+
+      # Add a new entry in the session interfaces
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def add(name:, **params)
+        self.api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Update an existing entry in the session interfaces
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def update(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Delete an entry from the session interfaces
+      #
+      # @param name [String] Entry name
+      # @return [Hash, nil] API response
+      #
+      def delete(name:)
+        @@api.delete(endpoint: self.endpoint + [name])
+      end
+    end
+  end
+end

data/lib/fluffy/session/rules.rb

@@ -0,0 +1,55 @@
+module Fluffy
+  class Session
+    class Rules
+      include Fluffy::API
+
+      # @return [String] The session endpoint
+      attr_reader :endpoint
+
+      # Create a rules instance for a given session
+      #
+      # @param endpoint [String] API session endpoint
+      #
+      def initialize(endpoint:)
+        @endpoint = endpoint + ['rules']
+      end
+
+      # Retrieve the session rules
+      #
+      # @return [Hash] The session rules
+      #
+      def get
+        @@api.get(endpoint: self.endpoint)
+      end
+
+      # Add a new entry in the session rules
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def add(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Update an existing entry in the session rules
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def update(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Delete an entry from the session rules
+      #
+      # @param name [String] Entry name
+      # @return [Hash, nil] API response
+      #
+      def delete(name:)
+        @@api.delete(endpoint: self.endpoint + [name])
+      end
+    end
+  end
+end

data/lib/fluffy/session/services.rb

@@ -0,0 +1,55 @@
+module Fluffy
+  class Session
+    class Services
+      include Fluffy::API
+
+      # @return [String] The session endpoint
+      attr_reader :endpoint
+
+      # Create a services instance for a given session
+      #
+      # @param endpoint [String] API session endpoint
+      #
+      def initialize(endpoint:)
+        @endpoint = endpoint + ['services']
+      end
+
+      # Retrieve the session services
+      #
+      # @return [Hash] The session services
+      #
+      def get
+        @@api.get(endpoint: self.endpoint)
+      end
+
+      # Add a new entry in the session services
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def add(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Update an existing entry in the session services
+      #
+      # @param name [String] Entry name
+      # @param **params [Hash] Any number of parameters to push into the Hash
+      # @return [Hash, nil] API response
+      #
+      def update(name:, **params)
+        @@api.post(endpoint: self.endpoint + [name], params: params)
+      end
+
+      # Delete an entry from the session services
+      #
+      # @param name [String] Entry name
+      # @return [Hash, nil] API response
+      #
+      def delete(name:)
+        @@api.delete(endpoint: self.endpoint + [name])
+      end
+    end
+  end
+end

data/lib/fluffy/sessions.rb

@@ -0,0 +1,36 @@
+require_relative 'session'
+
+module Fluffy
+  class Sessions
+    include Fluffy::API
+
+    # @return [String] Sessions API endpoint
+    attr_reader :endpoint
+
+    # Create a Sessions object
+    #
+    # @param api [Fluffy::Client::API] Client API instance
+    #
+    def initialize
+      @endpoint = ['sessions']
+    end
+
+    # Retrieve the active sessions
+    #
+    # @return [Hash] List of sessions
+    #
+    def get
+      @@api.get(endpoint: self.endpoint)
+    end
+
+    # Create a new session
+    #
+    # @param name [String] Session key
+    # @param **params [Hash] Any number of session parameters to push into the Hash
+    # @return [Fluffy::Session] Session instance
+    #
+    def add(name:, **params)
+      Session.new(name: name, **params)
+    end
+  end
+end

data/lib/fluffy/version.rb

@@ -0,0 +1,7 @@
+module Fluffy
+  VERSION = "0.0.1"
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: fluffy-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Ruby client library for Fluffy REST API
+email: matteo.cerutti@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fluffy/api.rb
+- lib/fluffy/client.rb
+- lib/fluffy/session.rb
+- lib/fluffy/session/addressbook.rb
+- lib/fluffy/session/chains.rb
+- lib/fluffy/session/interfaces.rb
+- lib/fluffy/session/rules.rb
+- lib/fluffy/session/services.rb
+- lib/fluffy/sessions.rb
+- lib/fluffy/version.rb
+homepage: https://github.com/m4ce/fluffy-ruby
+licenses:
+- Apache 2.0
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby client library that allows to interact with the Fluffy REST API
+test_files: []