flespi-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f262a2944da429c699df621f31663c46c4f4884de4b123ac87d09400456d46d6
+  data.tar.gz: fdece8e234c2c9c3dab2a26ae7ff48a96dcb4b98e48fe44b4a0ebb589121d700
+SHA512:
+  metadata.gz: 6c44d46a2a85ff6fec12c1d7871af7dd154d9a9db9b0b7bdf4ebca158ead1780f48d5695ac04e2c972d9957e3887e40a1c8573711c6d5ee785545cfce1fcb3c7
+  data.tar.gz: 9206da585dc048e7b858e4e7481d9be8e34fe75462c8db526cdea15a7f07b37698cf22ec09eb87108916f3d5d3d95872a08909de3918bb1591aa31a90c82a7ce

data/.rspec

@@ -0,0 +1,6 @@
+--format documentation
+--color
+--require spec_helper
+
+require:
+  - rubocop-rspec

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Vladislav Kostikov
+
+MIT License
+
+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,37 @@
+# Flespi
+[![Gem Version](https://badge.fury.io/rb/flespi-ruby.svg)](https://badge.fury.io/rb/flespi-ruby)
+
+[Official documentation Flespi](https://flespi.io/docs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem "flespi-ruby"`
+
+And then execute:
+
+`bundle install`
+
+## Usage
+
+```ruby
+require "flespi"
+
+# Initialize flespi instance
+flespi_client = Flespi.new("FlespiToken", debug: true)
+
+# Get collection of all devices
+flespi_client.get("/gw/devices/all")
+
+# Get device by device id
+flespi_client.get("/gw/devices/123456")
+
+# Create new device
+flespi_client.create("/gw/devices", ["configuration": { "ident": "123456" }, 
+                                     "device_type_id": 10, 
+                                     "name": "Device name"])
+
+# Delete device by device id
+flespi_client.delete("/gw/devices/123456")
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/flespi-ruby.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/flespi"
+
+Gem::Specification.new do |spec|
+  spec.name = "flespi-ruby"
+  spec.version = "1.0.0"
+  spec.authors = ["Vladislav Kostikov"]
+  spec.email = ["vlad@kostikov.ru"]
+
+  spec.summary = "flespi.io"
+  spec.homepage = "https://github.com/vladkostikov/flespi-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json", ">= 1"
+end

data/lib/flespi.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+class Flespi
+  attr_accessor :flespi_token, :debug
+
+  VERSION = "1.0.2.1"
+
+  def initialize(flespi_token, debug: false)
+    self.flespi_token = flespi_token
+    self.debug = debug
+  end
+
+  def get(url)
+    uri = URI.parse("https://flespi.io#{url}")
+
+    if debug
+      puts "================ FLESPI REQUEST ================"
+      puts "Request: GET https://flespi.io#{url}"
+      puts "================================================"
+    end
+
+    request = Net::HTTP::Get.new(uri)
+
+    validate_response(make_request(request, uri))
+  end
+
+  def create(url, parameters)
+    uri = URI.parse("https://flespi.io#{url}")
+
+    if debug
+      puts "================ FLESPI REQUEST ================"
+      puts "Request: POST https://flespi.io#{url}"
+      puts "================================================"
+    end
+
+    request = Net::HTTP::Post.new(uri)
+
+    validate_response(make_request(request, uri, parameters))
+  end
+
+  def update(url, parameters)
+    uri = URI.parse("https://flespi.io#{url}")
+
+    if debug
+      puts "================ FLESPI REQUEST ================"
+      puts "Request: PUT https://flespi.io#{url}"
+      puts "================================================"
+    end
+
+    request = Net::HTTP::Put.new(uri)
+
+    validate_response(make_request(request, uri, parameters))
+  end
+
+  def delete(url)
+    uri = URI.parse("https://flespi.io#{url}")
+
+    if debug
+      puts "================ FLESPI REQUEST ================"
+      puts "Request: DELETE https://flespi.io#{url}"
+      puts "================================================"
+    end
+
+    request = Net::HTTP::Delete.new(uri)
+
+    validate_response(make_request(request, uri))
+  end
+
+  protected
+
+  def make_request(request, uri, parameters = nil)
+    request["Accept"] = "application/json"
+    request["Authorization"] = "FlespiToken #{flespi_token}"
+
+    unless parameters.nil?
+      if debug
+        puts "================ FLESPI PARAMS ================"
+        puts "Parameters: #{parameters.inspect}"
+        puts "==============================================="
+      end
+      request.body = JSON.dump(parameters)
+    end
+
+    req_options = {
+      use_ssl: uri.scheme == "https"
+    }
+
+    Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(request)
+    end
+  end
+
+  def validate_response(response)
+    case response.code.to_i
+    when 200
+      { error: false, message: JSON.parse(response.body) }
+    when 400
+      { error: true, message: "Invalid parameters", reason: JSON.parse(response.body) }
+    when 401
+      { error: true, message: "Invalid or missing flespi token" }
+    when 403
+      { error: true, message: "Flespi token blocked" }
+    else
+      { error: true, message: "Flespi internal server error" }
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: flespi-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladislav Kostikov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- vlad@kostikov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- flespi-ruby.gemspec
+- lib/flespi.rb
+homepage: https://github.com/vladkostikov/flespi-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vladkostikov/flespi-ruby
+  source_code_uri: https://github.com/vladkostikov/flespi-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: flespi.io
+test_files: []