enlighten 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 490f41eb62d8eaa500eee7d55b146cada84cb1d2
+  data.tar.gz: 89e55551d49d54fa9e7c11dba4ba15a4444f62fd
+SHA512:
+  metadata.gz: 3d6a8250062987be653d60689e6110f4a8f129681038bf55f384f955cead46d8c4ef4fc78c0cdaf935d2bd165af55130dceb1016cf7c20ea9d7d3373cc799283
+  data.tar.gz: cebf2777340f390901c5fe99e26c4350a22e24a79cd85f1d48047c0b4dfb83c954dd2f5f9f9661ef417bfe8e690107b9dba93f9d632661de9584ec3fd6fba1ee

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enlighten_system.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Robert Martin
+
+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,54 @@
+
+# Enlighten
+
+Ruby Gem for use with the Enphase "Elighten" API version 2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enlighten', :git => 'https://github.com/datadude/enlighten.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+### Rails
+#### Configuraton
+
+Add the following line to an initializer at `config/initializers/enlighten.rb`:
+
+```ruby
+Enlighten::System.config(
+    key: '0960c4df1203f3079489fa8ccc251b59', user_id: '4d7a45774e6a41320a'
+)
+```
+
+#### Controller
+
+From the Example App: `https://github.com/datadude/enlighten-example`
+
+```ruby
+  def home
+    @system = Enlighten::System.new(params[:id])
+    @summary = @system.summary
+    @inventory = @system.inventory
+    @envoys = @system.envoys
+    @production = @system.monthly_production(:start_date=>1.month.ago - 1.day)
+    @stats = @system.stats(:start_at=>DateTime.new(Time.now.year,Time.now.month,Time.now.day,7,0), :end_at=>Time.now)
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/enlighten_system/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/enlighten.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enlighten/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enlighten"
+  spec.version       = Enlighten::VERSION
+  spec.authors       = ["Robert Martin"]
+  spec.email         = [""]
+  spec.summary       = %q{Use this gem to connect to the enphase 'enlighten' API.  }
+  spec.description   = %q{Docs at https://developer.enphase.com/docs}
+  spec.homepage      = "https://www.github.com/datadude/enlighten"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end
+

data/lib/enlighten.rb

@@ -0,0 +1,78 @@
+require 'json'
+require 'net/http'
+require 'digest'
+
+module Enlighten
+  class EnlightenError < StandardError
+  end
+  class EnlightenApiError < EnlightenError
+    attr_reader :code
+    def initialize(json)
+        @code = json.reason.to_i if json.reason.to_i
+        super((json.message && json.message.join('; ')) || json.reason)
+    end
+  end
+
+  class System
+    @default_params = {
+        host: 'api.enphaseenergy.com',
+        path: '/api/v2/systems',
+        time_zone: 7
+    }
+
+    class << self
+      def config(args={})
+        @default_params = @default_params.merge(args).freeze unless args.empty?
+        @default_params
+      end
+      # Allows to set defaults through app configuration:
+      #
+      #    config.action_mailer.default_options = { from: "no-reply@example.org" }
+      alias :default_options= :config
+    end
+
+    def method_missing(method,*args)
+      @attributes[method.to_s + Digest::MD5.base64digest(args[0].to_s)] ||= fetch(method, args[0])
+    end
+
+    def initialize(id)
+      @id = id
+      @attributes = {}
+    end
+
+    def self.find(id)
+      new(id)
+    end
+
+    def self.default_params
+      @default_params
+    end
+
+    def self.url
+      "https://#{@default_params[:host]}#{@default_params[:path]}"
+    end
+
+protected
+    def fetch(method, args={})
+      result = OpenStruct.new(JSON.parse(api_response(method,args)))
+      raise(EnlightenApiError.new(result)) if result.respond_to?(:reason)
+      result
+    end
+
+    def api_response(method,args={})
+      Net::HTTP.get(URI(format_url(method,args)))
+    end
+
+    def format_url(method,args={})
+      params = {key: self.class.default_params[:key], user_id: self.class.default_params[:user_id]}.merge(args||{})
+      self.class.url + '/' +  @id.to_s + '/' + method.to_s + '?' + query_string(params)
+    end
+    def query_string(args)
+      args.map{|k,v|value= (['start_at','end_at'].include? k.to_s)  ? v.to_i.to_s : date_format(v);"#{k.to_s}=#{CGI.escape(value)}"}.join('&')
+    end
+    def date_format(date)
+      date ? (date.respond_to?(:strftime)?date.strftime('%Y-%m-%d'):date.to_s) : ''
+    end
+
+  end
+end

data/lib/enlighten/version.rb

@@ -0,0 +1,3 @@
+module Enlighten
+  VERSION = "0.1.0"
+end

data/test/fixtures/energy_lifetime.json

@@ -0,0 +1,371 @@
+{
+  "system_id": 67,
+  "start_date": "2010-01-01",
+  "production": [
+    3127,
+    14110,
+    17198,
+    15659,
+    14237,
+    6539,
+    4290,
+    10067,
+    4420,
+    4358,
+    6763,
+    5630,
+    16868,
+    20527,
+    8873,
+    8483,
+    4225,
+    5329,
+    10043,
+    6402,
+    1062,
+    9669,
+    17194,
+    4439,
+    2282,
+    5438,
+    13094,
+    12720,
+    5866,
+    14052,
+    10574,
+    8738,
+    11305,
+    14856,
+    2916,
+    15552,
+    16057,
+    27711,
+    13529,
+    8295,
+    17578,
+    15026,
+    10560,
+    19489,
+    21192,
+    22895,
+    26994,
+    25892,
+    14793,
+    4146,
+    7647,
+    10755,
+    25478,
+    2956,
+    21711,
+    20036,
+    6465,
+    20471,
+    28685,
+    6525,
+    19653,
+    15296,
+    26730,
+    15237,
+    23879,
+    32267,
+    27005,
+    27128,
+    34080,
+    32566,
+    6583,
+    34968,
+    33152,
+    34043,
+    30036,
+    32771,
+    33954,
+    34776,
+    25908,
+    22426,
+    34804,
+    34827,
+    29282,
+    29091,
+    36017,
+    35532,
+    32512,
+    13991,
+    31278,
+    14430,
+    30085,
+    12487,
+    31628,
+    7673,
+    34264,
+    38094,
+    37773,
+    38189,
+    38038,
+    11104,
+    5528,
+    30811,
+    33827,
+    34101,
+    36760,
+    36455,
+    34317,
+    38834,
+    22368,
+    37169,
+    21740,
+    39407,
+    39597,
+    39997,
+    39496,
+    31209,
+    24311,
+    29883,
+    39720,
+    41366,
+    39875,
+    40160,
+    39827,
+    40365,
+    41138,
+    41510,
+    41696,
+    41461,
+    32475,
+    23574,
+    41688,
+    38853,
+    40947,
+    33689,
+    34975,
+    23837,
+    9077,
+    35178,
+    20402,
+    41445,
+    36696,
+    38997,
+    42461,
+    18665,
+    9785,
+    34792,
+    25582,
+    42151,
+    41393,
+    40121,
+    34519,
+    40803,
+    35699,
+    29882,
+    18384,
+    37070,
+    39492,
+    40481,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    0,
+    39653,
+    38213,
+    36622,
+    38922,
+    35113,
+    37723,
+    38263,
+    38139,
+    38681,
+    39237,
+    38351,
+    38278,
+    38326,
+    38669,
+    33773,
+    18903,
+    34637,
+    35073,
+    32284,
+    35184,
+    30683,
+    15233,
+    26058,
+    37106,
+    37266,
+    35507,
+    34226,
+    37507,
+    38476,
+    34713,
+    32492,
+    32458,
+    33306,
+    35685,
+    33608,
+    11365,
+    26785,
+    35709,
+    34082,
+    33383,
+    34050,
+    32762,
+    32018,
+    34539,
+    31751,
+    32461,
+    31323,
+    31895,
+    31065,
+    27040,
+    26545,
+    25768,
+    33553,
+    31831,
+    31668,
+    30836,
+    34117,
+    31446,
+    29489,
+    33060,
+    29001,
+    24720,
+    33294,
+    33492,
+    32502,
+    32747,
+    25064,
+    32463,
+    33932,
+    32553,
+    33708,
+    32474,
+    31759,
+    31920,
+    33449,
+    29744,
+    32877,
+    32169,
+    36882,
+    37297,
+    36184,
+    35788,
+    35410,
+    33994,
+    26158,
+    27800,
+    31437,
+    34909,
+    25639,
+    17778,
+    11325,
+    34429,
+    28702,
+    34574,
+    33763,
+    33132,
+    32622,
+    33098,
+    31862,
+    31283,
+    31725,
+    32718,
+    25269,
+    21066,
+    9118,
+    27927,
+    29552,
+    29430,
+    19932,
+    26729,
+    27985,
+    27756,
+    27967,
+    27760,
+    26708,
+    24802,
+    27009,
+    17608,
+    4540,
+    21930,
+    23787,
+    15730,
+    10183,
+    4167,
+    3047,
+    2946,
+    21228,
+    27323,
+    15232,
+    7245,
+    4590,
+    5456,
+    15172,
+    25215,
+    25160,
+    21818,
+    16401,
+    9918,
+    9157,
+    11644,
+    24259,
+    17781,
+    22672,
+    23286,
+    22559,
+    22385,
+    21246,
+    23047,
+    23526,
+    23376,
+    15914,
+    5362,
+    10712,
+    16481,
+    14896,
+    19896,
+    23693,
+    22921,
+    18459,
+    10275,
+    15439,
+    23170,
+    12040,
+    16386,
+    4569,
+    4592,
+    4181,
+    5169,
+    14197,
+    12906,
+    2094,
+    8733,
+    3860,
+    13914,
+    3913,
+    5733,
+    3294,
+    16115,
+    14271,
+    3317,
+    4058,
+    5249,
+    3990,
+    6788,
+    7227,
+    11788,
+    13496,
+    1459,
+    4716,
+    11142,
+    3466,
+    17517,
+    21495,
+    7049
+  ]
+}