openwrt-luci 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef6eba252992a3bda94b27dcb4732e8823e7b4b349462d1b4bf403ef84374642
+  data.tar.gz: d016d7f9eba2274d037f412df63a95dfae8e509b3248eb294715734685ebd9ac
+SHA512:
+  metadata.gz: b010e707844633837bc2bc6083563f1a9caea6bde0cfef6bcd3a667f6b07a32cca1d48d4bd87230e0cf1ed23b4bad8c76387f8ffb22ad2ab7dc0055720ef70f8
+  data.tar.gz: a36eb7ee3520d7293cec299003207368ab8bde23cbef1779718f14e7480618981e4c7ba8726b22404889c60433a84d59effe83c1d0b812761868808618d8d5f3

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

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 contact@jasonchalom.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/TRex22/openwrt-luci" }
+
+# Specify your gem's dependencies in openwrt-luci.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    openwrt-luci (0.0.1)
+      active_attr (~> 0.16.0)
+      httparty (~> 0.22.0)
+      nokogiri (~> 1.16.5)
+      oj (~> 3.16.3)
+      pry (~> 0.14.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.3)
+      actionview (= 7.1.3.3)
+      activesupport (= 7.1.3.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.3)
+      activesupport (= 7.1.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    active_attr (0.16.0)
+      actionpack (>= 3.0.2, < 7.2)
+      activemodel (>= 3.0.2, < 7.2)
+      activesupport (>= 3.0.2, < 7.2)
+    activemodel (7.1.3.3)
+      activesupport (= 7.1.3.3)
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    csv (3.3.0)
+    drb (2.2.1)
+    erubi (1.12.0)
+    httparty (0.22.0)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.23.1)
+    multi_xml (0.7.1)
+      bigdecimal (~> 3.1)
+    mutex_m (0.2.0)
+    nokogiri (1.16.5-arm64-darwin)
+      racc (~> 1.4)
+    oj (3.16.3)
+      bigdecimal (>= 3.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.0)
+    rack (3.0.11)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin
+
+DEPENDENCIES
+  openwrt-luci!
+
+BUNDLED WITH
+   2.5.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jason Chalom
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jason Chalom
+
+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,57 @@
+# OpenwrtLuci
+API Client to communicate with OpenWRT via the Luci interface
+
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openwrt-luci'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openwrt-luci
+
+## Usage
+
+```ruby
+  require 'openwrt-luci'
+  client = OpenwrtLuci::Client.new(base_path: "http://192.168.0.1", port: 80, username: 'your username', password: 'your password', verify_ssl: false)
+  client.backup # Return backup file as a stream
+
+  # verify_ssl is used if the controller has SSL configured
+```
+
+### Endpoints
+  - Login
+  - Backup
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+### Tests
+To run tests execute:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/openwrt-luci. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the openwrt-luci: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/openwrt-luci/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openwrt-luci"
+
+# 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

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/openwrt-luci/client.rb

@@ -0,0 +1,161 @@
+module OpenwrtLuci
+  class Client
+    # include HTTParty_with_cookies
+
+    LOGIN_PATH = '/cgi-bin/luci'
+    BACKUP_PATH = '/cgi-bin/cgi-backup'
+
+    attr_reader :username,
+      :password,
+      :base_path,
+      :port,
+      :raw_cookie,
+      :sessionid,
+      :token,
+      :verify_ssl
+
+    def initialize(username:, password:, base_path:, port: 8443, verify_ssl: false)
+      @username = username
+      @password = password
+      @base_path = base_path
+      @port = port
+      @verify_ssl = verify_ssl
+    end
+
+    def self.compatible_api_version
+      'v1'
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      'v1 2024-05-28'
+    end
+
+    def backup
+      start_time = get_micro_second_time
+
+      login unless raw_cookie
+
+      response = HTTParty.send(
+        :post,
+        "#{base_path}:#{port}#{BACKUP_PATH}",
+        body: "sessionid=#{sessionid}",
+        port: port,
+        verify: verify_ssl
+      )
+
+      end_time = get_micro_second_time
+      construct_response_stream(response, start_time, end_time)
+    end
+
+    def login
+      start_time = get_micro_second_time
+
+      response = HTTParty.send(
+        :post,
+        "#{base_path}:#{port}#{LOGIN_PATH}",
+        body: "luci_username=#{username}&luci_password=#{password}",
+        port: port,
+        verify: verify_ssl
+      )
+
+      end_time = get_micro_second_time
+
+      @login_response = construct_response_object(response, LOGIN_PATH, start_time, end_time)
+
+      @token = response.body[/(token\": \")\w+/].split("token\": \"").last
+      @sessionid = response.body[/(sessionid\": \")\w+/].split("sessionid\": \"").last
+      @raw_cookie = { token: token, sessionid: sessionid }
+    end
+
+    private
+
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        'body' => response.body,
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_response_stream(response, start_time, end_time)
+      {
+        'body' => response.body,
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_metadata(response, start_time, end_time)
+      total_time = end_time - start_time
+
+      {
+        'start_time' => start_time,
+        'end_time' => end_time,
+        'total_time' => total_time
+      }
+    end
+
+    def body_is_present?(response)
+      !body_is_missing?(response)
+    end
+
+    def body_is_missing?(response)
+      response.body.nil? || response.body.empty?
+    end
+
+    def parse_body(response, path)
+      html_body = response.body
+      doc = Nokogiri::HTML(html_body)
+
+
+      # TODO:
+    rescue Oj::LoadError => _e
+      response.body
+    end
+
+    def parse_cookie(set_cookie_str, key)
+      value = nil
+      expiry = nil
+
+      set_cookie_str.each do |item|
+        if item.include?(key)
+          value = item.split('; ').first.split('=').last
+
+          if item.include?('Expires') || item.include?('expires')
+            item.split('; ').each do |sub_item|
+              if sub_item.include?('Expires') || sub_item.include?('expires')
+                expiry = Time.parse(sub_item.gsub('expires=', '').gsub('Expires=', ''))
+              end
+            end
+          end
+        end
+      end
+
+      [value, expiry]
+    end
+
+    def process_cookies
+      # Cookies are always a single string separated by spaces
+      raw_cookie.map { |item| item.split('; ').first }.join('; ')
+    end
+
+    def get_micro_second_time
+      (Time.now.to_f * 1000000).to_i
+    end
+
+    def construct_base_path(path, params)
+      constructed_path = "#{base_path}/#{path}"
+
+      if params == {}
+        constructed_path
+      else
+        "#{constructed_path}?#{process_params(params)}"
+      end
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+    end
+  end
+end

data/lib/openwrt-luci/version.rb

@@ -0,0 +1,3 @@
+module OpenwrtLuci
+  VERSION = "0.0.1"
+end

data/lib/openwrt-luci.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+# require 'httparty_with_cookies'
+require 'nokogiri'
+require 'oj'
+
+require 'openwrt-luci/version'
+require 'openwrt-luci/client'
+
+module OpenwrtLuci
+  class Error < StandardError; end
+end

data/openwrt-luci.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openwrt-luci/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openwrt-luci"
+  spec.version       = OpenwrtLuci::VERSION
+  spec.authors       = ["trex22"]
+  spec.email         = ["contact@jasonchalom.com"]
+
+  spec.summary       = "API Client to communicate with OpenWRT via the Luci interface"
+  spec.description   = "API Client to communicate with OpenWRT via the Luci interface. This is an unofficial project."
+  spec.homepage      = "https://github.com/TRex22/openwrt-luci"
+  spec.license       = "MIT"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.22.0"
+  spec.add_dependency "active_attr", "~> 0.16.0"
+  spec.add_dependency "nokogiri", "~> 1.16.5"
+  spec.add_dependency "oj", "~> 3.16.3"
+
+  # Development dependancies
+  spec.add_dependency "pry", "~> 0.14.2"
+  # TODO:
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: openwrt-luci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- trex22
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.5
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+description: API Client to communicate with OpenWRT via the Luci interface. This is
+  an unofficial project.
+email:
+- contact@jasonchalom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openwrt-luci.rb
+- lib/openwrt-luci/client.rb
+- lib/openwrt-luci/version.rb
+- openwrt-luci.gemspec
+homepage: https://github.com/TRex22/openwrt-luci
+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: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: API Client to communicate with OpenWRT via the Luci interface
+test_files: []