enlighten 0.1.0

data/test/fixtures/summary.json

@@ -0,0 +1 @@
+{"system_id": 67, "modules": 35, "size_w": 6270, "current_power": 1759, "energy_today": 23548, "energy_lifetime": 60771599, "summary_date": "2015-04-06", "source": "microinverters", "status": "normal", "operational_at": 1201362300, "last_report_at": 1428362526}

data/test/test_enlighten_system.rb

@@ -0,0 +1,128 @@
+require_relative 'test_helper'
+require 'date'
+
+describe Enlighten::System do
+  include Enlighten
+
+  let(:system){ Enlighten::System.new(67)}
+  before do
+    #my key with the test user id
+    Enlighten::System.config(key: '0960c4df1203f3079489fa8ccc251b59', user_id: '4d7a45774e6a41320a')
+  end
+  it "should initalize with default params" do
+    Enlighten::System.url.must_equal "https://api.enphaseenergy.com/api/v2/systems"
+  end
+  it "should should override the default params" do
+    Enlighten::System.config(host: 'bogus.enphaseenergy.com', path: '/bogus/v2/bogus')
+    Enlighten::System.url.must_equal "https://bogus.enphaseenergy.com/bogus/v2/bogus"
+    Enlighten::System.config(host: 'api.enphaseenergy.com', path: '/api/v2/systems')
+  end
+
+  describe "Function Calls" do
+
+
+    describe 'format_url' do
+      it "should format the url" do
+        system.send(:format_url,:summary).must_equal('https://api.enphaseenergy.com/api/v2/systems/67/summary?key=0960c4df1203f3079489fa8ccc251b59&user_id=4d7a45774e6a41320a')
+      end
+      it "should format the url with parameters" do
+        system.send(:format_url,:energy_lifetime,start_date: '2010-01-01',end_date: '2010-12-31').must_equal(
+            "https://api.enphaseenergy.com/api/v2/systems/67/energy_lifetime?key=0960c4df1203f3079489fa8ccc251b59&user_id=4d7a45774e6a41320a&start_date=2010-01-01&end_date=2010-12-31"
+        )
+      end
+      it "should format the url with Time parameters" do
+        start_date = DateTime.parse('2010-01-01')
+        end_date = DateTime.parse('2010-12-31')
+
+        system.send(:format_url,:energy_lifetime,start_date: start_date,end_date: end_date).must_equal(
+            "https://api.enphaseenergy.com/api/v2/systems/67/energy_lifetime?key=0960c4df1203f3079489fa8ccc251b59&user_id=4d7a45774e6a41320a&start_date=2010-01-01&end_date=2010-12-31"
+        )
+      end
+      it "should format the url with 'start_at', and 'end_at' parameters" do
+        system.send(:format_url,:stats,start_at: DateTime.strptime('2015-01-01 00:00','%Y-%m-%d %H:%M').to_time,end_at: DateTime.strptime('2015-01-02 00:00', '%Y-%m-%d %H:%M').to_time).must_equal(
+            "https://api.enphaseenergy.com/api/v2/systems/67/stats?key=0960c4df1203f3079489fa8ccc251b59&user_id=4d7a45774e6a41320a&start_at=1420070400&end_at=1420156800"
+        )
+      end
+    end
+
+    describe 'date_format' do
+      it "should format a date" do
+        date = DateTime.parse('2014-12-31')
+        system.send(:date_format, date).must_equal('2014-12-31')
+      end
+      it "should pass through a string" do
+        system.send(:date_format, '2014-12-31').must_equal('2014-12-31')
+      end
+    end
+
+    describe 'query_string' do
+      it "should return a valid query string if given a valid hash" do
+        system.send(:query_string,{:a=>'1',:b=>'2',:c=>'3'}).must_equal('a=1&b=2&c=3')
+      end
+
+      it "should CGI Encode the query string" do
+        system.send(:query_string,{:a=>'1',:b=>'2&2',:c=>'3/3'}).must_equal('a=1&b=2%262&c=3%2F3')
+      end
+    end
+  end
+
+
+  describe 'REST end points' do
+    it "should return a system summary upon creation" do
+        system.stub(:api_response, load_fixture(:summary)) do
+          system.summary.system_id.must_equal 67
+        end
+      end
+
+      it "should return system stats upon request" do
+        system.stub(:api_response, load_fixture(:stats)) do
+          system.stats.total_devices.must_equal 35
+        end
+      end
+
+      it "should return system inventory upon request" do
+        system.stub(:api_response, load_fixture(:inventory)) do
+          system.inventory.envoys[0]['sn'].must_equal "121112607295"
+        end
+      end
+      it "should return energy_lifetime upon request" do
+        system.stub(:api_response, load_fixture(:energy_lifetime)) do
+          system.energy_lifetime.start_date.must_equal "2010-01-01"
+        end
+      end
+    it "should return cached energy_lifetime upon request" do
+      system.stub(:api_response, load_fixture(:energy_lifetime)) do
+        system.energy_lifetime.start_date.must_equal "2010-01-01"
+      end
+      system.energy_lifetime.start_date.must_equal "2010-01-01"
+    end
+      it "should 'find' a system" do
+        system = Enlighten::System.find(67)
+        system.stub(:api_response, load_fixture(:summary)) do
+          system.summary.system_id.must_equal 67
+        end
+      end
+
+      it "should return a date range for enery lifetime." do
+        system.stub(:api_response, load_fixture(:energy_lifetime)) do
+          start_date = DateTime.parse("2010-01-01")
+          end_date = DateTime.parse("2010-12-31")
+          system.energy_lifetime(start_date: start_date, end_date: end_date).start_date.must_equal "2010-01-01"
+        end
+      end
+
+      it "should return a date range for enery lifetime if passed strings." do
+        system.stub(:api_response, load_fixture(:energy_lifetime)) do
+          system.energy_lifetime(start_date: "2010-01-01", end_date: "2010-12-31").start_date.must_equal "2010-01-01"
+        end
+      end
+
+      it "should raise an exception if an error code is returned." do
+        system.stub(:api_response, load_fixture(:error)) do
+          proc{system.summary}.must_raise Enlighten::EnlightenApiError
+        end
+      end
+    end
+  end
+
+

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/mock'
+require_relative '../lib/enlighten'
+FIXTURE_DIR = File.expand_path('../fixtures', __FILE__).freeze
+
+def load_fixture(method_name)
+  File.read(FIXTURE_DIR + '/' + method_name.to_s + '.json')
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: enlighten
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Docs at https://developer.enphase.com/docs
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enlighten.gemspec
+- lib/enlighten.rb
+- lib/enlighten/version.rb
+- test/fixtures/energy_lifetime.json
+- test/fixtures/envoys.json
+- test/fixtures/error.json
+- test/fixtures/inventory.json
+- test/fixtures/monthly_production.json
+- test/fixtures/rgm_stats.json
+- test/fixtures/stats.json
+- test/fixtures/summary.json
+- test/test_enlighten_system.rb
+- test/test_helper.rb
+homepage: https://www.github.com/datadude/enlighten
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Use this gem to connect to the enphase 'enlighten' API.
+test_files:
+- test/fixtures/energy_lifetime.json
+- test/fixtures/envoys.json
+- test/fixtures/error.json
+- test/fixtures/inventory.json
+- test/fixtures/monthly_production.json
+- test/fixtures/rgm_stats.json
+- test/fixtures/stats.json
+- test/fixtures/summary.json
+- test/test_enlighten_system.rb
+- test/test_helper.rb