nature_remo_e 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c394a4f88f7bac683e6967bede4091b8cca58f998e792065c01ebe738b29ab9
-  data.tar.gz: b1408b47bcbaee95e54e2bfd0106c379b252293a4f2075b64bea1ce20c4b0d1b
+  metadata.gz: 67168370d37a3df1c18c38ac393b5f36d65016f15845d304811403d0fce63200
+  data.tar.gz: 8b6182c418a3731a6db967f3133eff7ad99ec7c817662a0733dad35ab4508662
 SHA512:
-  metadata.gz: 6bd2c81e99deb768f5306ddec87e648e487bc297fb48d436329ff02dcfc2e14c1f0f205c0e17b8095a5ef3eb8a61f7909a0b293519ea615fc2c514440f20fa0b
-  data.tar.gz: 80e28b4392d5a9c36abb79b1668f6416aaebf85c3275a354aff098bf077649d48dfa59a8985bc80f0a17691fb4d6b1991f9f20cf263c98b22869904d09c29e09
+  metadata.gz: 67dc246c78b27ee6f97a995acd77b5cf5dde2622e6a25e6df0c54ed3b4e338b30761670050111f42c8030a0e0b0727bebde2fcba050aa4926ae4fdcd4acc4f59
+  data.tar.gz: c423e40de4205b13de03e5f07438c36c7eb679654621b23aff512d8b094e7f7edce4bad60a85514743bc810a47326e0c1abac491555f34825e3d3ae27a825469

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', 3.1]
+        ruby: [2.6, 2.7, '3.0', 3.1]
     name: Ruby ${{ matrix.ruby }}
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.6
   NewCops: enable
   Exclude:
     - '*.gemspec'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
-[full changelog](https://github.com/ytkg/nature_remo_e/compare/v1.0.2...main)
+[full changelog](https://github.com/ytkg/nature_remo_e/compare/v2.0.0...main)
+
+## v2.0.0
+[full changelog](https://github.com/ytkg/nature_remo_e/compare/v1.0.2...v2.0.0)
+
+* :bomb: **[BREAKING CHANGE]** Drop support ruby 2.5
+  * https://github.com/ytkg/nature_remo_e/pull/3
+
+* Add CLI command
+  * https://github.com/ytkg/nature_remo_e/pull/5
 
 ## v1.0.2
 [full changelog](https://github.com/ytkg/nature_remo_e/compare/v1.0.1...v1.0.2)

data/Gemfile

@@ -6,9 +6,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-
 gem 'rspec'
-
 gem 'rubocop'
-
 gem 'webmock'

data/README.md

@@ -54,6 +54,45 @@ client.measured_instantaneous
 #=> 630
 ```
 
+### CLI
+```bash
+$ remoe
+coefficient: 1
+cumulative_electric_energy_effective_digits: 6
+normal_direction_cumulative_electric_energy: 72164
+cumulative_electric_energy_unit: 1
+reverse_direction_cumulative_electric_energy: 10
+measured_instantaneous: 651
+
+$ bundle exec ruby exe/remoe --json | jq .
+{
+  "coefficient": 1,
+  "cumulative_electric_energy_effective_digits": 6,
+  "normal_direction_cumulative_electric_energy": 72164,
+  "cumulative_electric_energy_unit": 1,
+  "reverse_direction_cumulative_electric_energy": 10,
+  "measured_instantaneous": 651
+}
+
+$ remoe coefficient
+1
+
+$ remoe cumulative_electric_energy_effective_digits
+6
+
+$ remoe normal_direction_cumulative_electric_energy
+72164
+
+$ remoe cumulative_electric_energy_unit
+1
+
+$ remoe reverse_direction_cumulative_electric_energy
+10
+
+$ remoe measured_instantaneous
+651
+```
+
 ## 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.

data/exe/remoe

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'nature_remo_e'
+
+NatureRemoE::Cli.start

data/lib/nature_remo_e/cli.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module NatureRemoE
+  class Cli < Thor
+    default_command :all
+
+    desc 'all', 'Get all value'
+    option 'json', type: :boolean
+    def all
+      return puts echonetlite_properties.to_json if options['json']
+
+      echonetlite_properties.each do |name, value|
+        puts "#{name}: #{value}"
+      end
+    end
+
+    desc 'coefficient', 'Get coefficient value'
+    def coefficient
+      puts echonetlite_properties[:coefficient]
+    end
+
+    desc 'cumulative_electric_energy_effective_digits', 'Get cumulative_electric_energy_effective_digits value'
+    def cumulative_electric_energy_effective_digits
+      puts echonetlite_properties[:cumulative_electric_energy_effective_digits]
+    end
+
+    desc 'normal_direction_cumulative_electric_energy', 'Get normal_direction_cumulative_electric_energy value'
+    def normal_direction_cumulative_electric_energy
+      puts echonetlite_properties[:normal_direction_cumulative_electric_energy]
+    end
+
+    desc 'cumulative_electric_energy_unit', 'Get cumulative_electric_energy_unit value'
+    def cumulative_electric_energy_unit
+      puts echonetlite_properties[:cumulative_electric_energy_unit]
+    end
+
+    desc 'reverse_direction_cumulative_electric_energy', 'Get reverse_direction_cumulative_electric_energy value'
+    def reverse_direction_cumulative_electric_energy
+      puts echonetlite_properties[:reverse_direction_cumulative_electric_energy]
+    end
+
+    desc 'measured_instantaneous', 'Get measured_instantaneous value'
+    def measured_instantaneous
+      puts echonetlite_properties[:measured_instantaneous]
+    end
+
+    private
+
+    def echonetlite_properties
+      client = NatureRemoE::Client.new(ENV['NATURE_REMO_API_TOKEN'])
+      client.echonetlite_properties
+    rescue StandardError => e
+      puts e.message
+      exit!
+    end
+  end
+end

data/lib/nature_remo_e/client.rb

@@ -5,14 +5,17 @@ require 'json'
 
 module NatureRemoE
   class Client
+    BASE_URL = 'https://api.nature.global'
+    API_VERSION = '1'
+
     def initialize(token)
       @token = token
     end
 
     def echonetlite_properties
-      device[:smart_meter][:echonetlite_properties].map do |echonetlite_property|
+      device[:smart_meter][:echonetlite_properties].to_h do |echonetlite_property|
         [echonetlite_property[:name].to_sym, echonetlite_property[:val].to_i]
-      end.to_h
+      end
     end
 
     def coefficient
@@ -41,21 +44,25 @@ module NatureRemoE
 
     private
 
+    def headers
+      {
+        'User-Agent' => "NatureRemoE v#{NatureRemoE::VERSION} (https://github.com/ytkg/nature_remo_e)",
+        'Authorization' => "Bearer #{@token}"
+      }
+    end
+
     def client
-      @client ||= Faraday.new(
-        url: 'https://api.nature.global',
-        headers: { Authorization: "Bearer #{@token}" }
-      )
+      @client ||= Faraday.new(url: "#{BASE_URL}/#{API_VERSION}", headers: headers) do |f|
+        f.response :json, parser_options: { symbolize_names: true }
+      end
     end
 
     def appliances
-      response = client.get do |req|
-        req.url '/1/appliances'
-      end
+      response = client.get('appliances')
 
-      raise NatureRemoE::Error, JSON.parse(response.body, symbolize_names: true)[:message] if response.status != 200
+      raise NatureRemoE::Error, response.body[:message] if response.status != 200
 
-      JSON.parse(response.body, symbolize_names: true)
+      response.body
     end
 
     def device

data/lib/nature_remo_e/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NatureRemoE
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/lib/nature_remo_e.rb

@@ -2,6 +2,8 @@
 
 require_relative 'nature_remo_e/version'
 require_relative 'nature_remo_e/client'
+require_relative 'nature_remo_e/cli'
+require_relative 'patches/thor_ext'
 
 module NatureRemoE
   class Error < StandardError; end

data/lib/patches/thor_ext.rb

@@ -0,0 +1,26 @@
+# rubocop:disable all
+class Thor
+  class << self
+    def exit_on_failure?
+      true
+    end
+
+    def help(shell, subcommand = false)
+      list = printable_commands(true, subcommand)
+      Thor::Util.thor_classes_in(self).each do |klass|
+        list += klass.printable_commands(false)
+      end
+      # list.sort! { |a, b| a[0] <=> b[0] }
+
+      if defined?(@package_name) && @package_name
+        shell.say "#{@package_name} commands:"
+      else
+        shell.say "Commands:"
+      end
+
+      shell.print_table(list, :indent => 2, :truncate => true)
+      shell.say
+      class_options_help(shell)
+    end
+  end
+end

data/nature_remo_e.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   # spec.description   = "TODO: Write a longer description or delete this line."
   spec.homepage      = "https://github.com/ytkg/nature_remo_e"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency "faraday", "~> 1.3.0"
+  spec.add_dependency "faraday", ">= 2.0.0"
+  spec.add_dependency "thor"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,33 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: nature_remo_e
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Yoshiki Takagi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-03 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
-description: 
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  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:
 - yoshiki.tkg@gmail.com
-executables: []
+executables:
+- remoe
 extensions: []
 extra_rdoc_files: []
 files:
@@ -43,9 +58,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/remoe
 - lib/nature_remo_e.rb
+- lib/nature_remo_e/cli.rb
 - lib/nature_remo_e/client.rb
 - lib/nature_remo_e/version.rb
+- lib/patches/thor_ext.rb
 - nature_remo_e.gemspec
 homepage: https://github.com/ytkg/nature_remo_e
 licenses:
@@ -53,7 +71,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ytkg/nature_remo_e
   source_code_uri: https://github.com/ytkg/nature_remo_e
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,15 +79,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Nature Remo API client for Nature Remo E
 test_files: []