geostellar_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 688b9bfbd3b286b380fbff15db90c8e742ab44de
-  data.tar.gz: 84935065f7c75b5f15422bf3e9faeabe3b2219ee
+  metadata.gz: 1791a78e5924e88bb802f6a936664411e97aa0a3
+  data.tar.gz: ee1492b2c1562dd341794541e08f08f72a3cd4bb
 SHA512:
-  metadata.gz: 48ba81ebbe258cdec59d553e68296c3b5cad9fabb4873451326a56dbf8e655da97b581f8e2133c7c6818a328968c38d4fb58171e59af131a115e07ca600e6f1d
-  data.tar.gz: 1413d48e7a86d5301979ad3eee61d1569a8805da474f22115645ad771933e97d6c412f0c048126a75b5126306db1cf4b7dc77c9372940d39f706e10538ad7585
+  metadata.gz: d7bfc30cabe84773de22b860d4430f9934738b3017768d8f27fed85f5e58b34ef8a116e766ab4437ccf067c6ec8a9c6c22e1c731eb6d0daac4dc92a9e1462c2a
+  data.tar.gz: d7eddc7475ac0875ced1b711ffe8b5181f11c146cc4ac0b9ad0bc587f25e5a64c6b0ab95350abf339c2d2c7c224990b93090fb84243f24c7e575d6488a10855c

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 spec/credentials.yml
+*.gem

data/README.md

@@ -24,14 +24,10 @@ Or install it yourself as:
 Configure the client with your API key:
 
 ```ruby
-GeostellarClient = YOURAPIKEY
+GeostellarClient.api_key = YOURAPIKEY
 ```
 
-To fetch a user:
-
-```ruby
-user = GeostellarClient::User.find(1)
-```
+### User
 
 A user has the following attributes:
 
@@ -46,8 +42,38 @@ street_address_2, String
 city, String
 state, String
 zip_code, String
+password, String
 ```
 
+`password` is only used internally when talking to the user creation API.  The User object returned by `User#create` has a password value of `nil`.
+
+#### To fetch a user:
+
+```ruby
+user = GeostellarClient::User.find(1)
+```
+
+#### To create a user:
+
+```ruby
+attributes = {
+  email: 'someemail@example.com',
+  password: 'password',
+  phone: '123456789',
+  first_name: 'Foo',
+  last_name: 'Bar',
+  street_address_1: '1 Street',
+  street_address_2: 'Address',
+  city: 'The City',
+  state: 'OR',
+  zip_code: '12345',
+}
+
+user = GeostellarClient::User.create(attributes)
+```
+
+When successful this returns a `User` object.  Otherwise a `GeostellarClient::UserCreationError` is raised, with the message returned by the API.
+
 
 ## Development
 
@@ -57,6 +83,14 @@ Then, run `rake rspec` to run the tests. You can also run `bin/console` for an i
 
 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).
 
+### To-do
+
+- Update user
+- Log-in
+- Log-out
+- PV Module, Incentive, Solar estimate models and API calls
+- Address and monthly bill search
+
 
 ## Contributing
 

data/lib/geostellar_client.rb

@@ -2,6 +2,7 @@ require 'virtus'
 require 'httparty'
 require 'geostellar_client/version'
 require 'geostellar_client/user'
+require 'geostellar_client/exceptions'
 
 module GeostellarClient
   class << self

data/lib/geostellar_client/exceptions.rb

@@ -0,0 +1,5 @@
+module GeostellarClient
+  class Error < StandardError; end
+
+  class UserCreationError < Error; end
+end

data/lib/geostellar_client/user.rb

@@ -13,6 +13,7 @@ module GeostellarClient
     attribute :city, String
     attribute :state, String
     attribute :zip_code, String
+    attribute :password, String
 
     def self.find(id)
       response = HTTParty.get(
@@ -22,6 +23,23 @@ module GeostellarClient
       new(JSON.parse(response.body))
     end
 
+    def self.create(attrs)
+      valid_attrs = User.new(attrs).attributes.reject { |k, v| v.nil? }
+      options = {
+        api_key: GeostellarClient.api_key,
+        body: { user: valid_attrs },
+      }
+
+      response = HTTParty.post(api_url, options)
+
+      if response.success?
+        new(response.parsed_response)
+      else
+        message = response["errors"].join(', ')
+        raise GeostellarClient::UserCreationError, message
+      end
+    end
+
     private
 
     def self.find_url(id)

data/lib/geostellar_client/version.rb

@@ -1,3 +1,3 @@
 module GeostellarClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geostellar_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - JP Moral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -169,6 +169,7 @@ files:
 - bin/setup
 - geostellar_client.gemspec
 - lib/geostellar_client.rb
+- lib/geostellar_client/exceptions.rb
 - lib/geostellar_client/user.rb
 - lib/geostellar_client/version.rb
 homepage: https://github.com/jpmoral/geostellar_client