gro_social 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b578a59a7d7c43b325f7044b7627907812a3c50
-  data.tar.gz: 6e63949a4e84d4524c1b22e45408d8b8f774a90f
+  metadata.gz: a85919082f2b422d6af27ca25f65dfc708d02631
+  data.tar.gz: d019a4c597f24a24b50f53ebbf6cc1035df7e44a
 SHA512:
-  metadata.gz: 7243e7cd5067cb31eeb8e7cc85d1ef3bdf13ae9304bc21cf80b3094d02d418fec2df7df7ca2c62c707563dd31214e911d587b1b4c3d765a76ef5789a16aac4b6
-  data.tar.gz: 7cba85e96c4bfd8214cb2cf5fb7df5f5e47c4e50c0e79a2e94ad1db003a4f9bd119b1a5ac6924016f35934c59703acd7d99898f09964e025e879f305ba36c04c
+  metadata.gz: 75df8e90998b13945b6d666aef675f8cbd480d8cfc7db08ad8a2a77cd8cb5c2ccc7b89d466933d0c04e60a6dda36bef22fdb7b7ebe0e2dcc7ba27128231b2c57
+  data.tar.gz: 126f4b09d39a95a99e4a095831bcbd19318589a8fd7c095f8dd8bf65b1ee6b5a1ae530ad7e2e88f470f5d1ae0b32c74b8f280542c9c4984961e89c72a0c30f4c

data/README.md

@@ -47,6 +47,12 @@ interact with the supported resources.
 There are two classes that you will work with in regards to users:
 `GroSocial::Users` and `GroSocial::User`. `GroSocial::Users` represents the
 class you will use to locate specific users or iterate over them.
+`GroSocial::Users` can be treated like a Hash when it comes to accessing and
+working with the `GroSocial::User` records.
+
+#### Retrieval
+
+Retrieval is keyed to the ID for the user you want to access.
 
 ```ruby
 user = GroSocial::Users[1234]   # GroSocial::User
@@ -56,6 +62,26 @@ user.firstname  # 'John'
 user.lastname   # 'Doe'
 ```
 
+#### Creation
+
+The `<<` operation is used to both create and update records and its behavior
+is based on whether the `GroSocial::User` being pushed in already has an ID
+value set.
+
+```ruby
+user = GroSocial::User.new(
+    firstname:  'John',
+    lastname:   'Doe',
+    email:      'johndoe@example.com',
+    password:   'secret123'
+)
+user.id         # nil
+
+GroSocial::Users << user
+
+user.id         # '12345'
+```
+
 ### Subscriptions
 
 TODO: Document the GroSocial::Subscription API

data/lib/gro_social/user.rb

@@ -1,6 +1,7 @@
 module GroSocial
   class User
-    attr_accessor :id, :firstname, :lastname, :email, :phone, :created, :custom1, :custom2, :custom3, :alertmessage
+    attr_accessor :id, :firstname, :lastname, :email, :phone, :created,
+                  :custom1, :custom2, :custom3, :alertmessage, :password
 
     def initialize(attributes = {})
       attributes.each do |attr_name, value|

data/lib/gro_social/users.rb

@@ -8,8 +8,25 @@ module GroSocial
       GroSocial::User.new(result['result']['user'])
     end
 
-    def self.each(&block)
-
+    def self.<<(user)
+      options = { typhoeus: { body: {
+          firstname:    user.firstname,
+          lastname:     user.lastname,
+          email:        user.email,
+          password:     user.password,
+          phone:        user.phone,
+          custom1:      user.custom1,
+          custom2:      user.custom2,
+          custom3:      user.custom3,
+          alertmessage: user.alertmessage
+      }}}
+      result = GroSocial::Client.request('Users', :post, options)
+      user.id = result['result']['User']['id']
+      user
     end
+
+    # def self.each(&block)
+    #
+    # end
   end
 end

data/lib/gro_social/version.rb

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

data/spec/gro_social/users_spec.rb

@@ -21,15 +21,43 @@ RSpec.describe GroSocial::Users do
     end
   end
 
-  describe '.each' do
+  describe '.<<' do
     it 'responds' do
-      expect(GroSocial::Users).to respond_to(:each)
+      expect(GroSocial::Users).to respond_to(:<<)
     end
 
-    it 'returns GroSocial::User instances' do
-      # GroSocial::Users.each do |user|
-      #   expect(user).to be_a_kind_of(GroSocial::User)
-      # end
+    context 'with a fresh user' do
+      vcr_options = { cassette_name: 'GroSocial_Users/creating_a_user' }
+
+      let(:user) do
+        GroSocial::User.new(firstname:  'John',
+                            lastname:   'Doe',
+                            email:      'johndoe@example.org',
+                            password:   'secret123',
+                            phone:      '(555) 123-4567')
+      end
+
+      it 'accepts and returns a GroSocial::User', vcr: vcr_options do
+        expect(GroSocial::Users << user).to be_a(GroSocial::User)
+      end
+
+      it 'updates the :id field', vcr: vcr_options do
+        expect(user.id).to be_nil
+        GroSocial::Users << user
+        expect(user.id).to_not be_nil
+      end
     end
   end
+
+  # describe '.each' do
+  #   it 'responds' do
+  #     expect(GroSocial::Users).to respond_to(:each)
+  #   end
+  #
+  #   it 'returns GroSocial::User instances' do
+  #     # GroSocial::Users.each do |user|
+  #     #   expect(user).to be_a_kind_of(GroSocial::User)
+  #     # end
+  #   end
+  # end
 end

data/vcr_cassettes/GroSocial_Users/creating_a_user.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://apidev.grosocial.com/users?key=<API_KEY>&p=<API_PASSWORD>
+    body:
+      encoding: UTF-8
+      string: alertmessage=&custom1=&custom2=&custom3=&email=johndoe%40example.org&firstname=John&lastname=Doe&password=secret123&phone=%28555%29%20123-4567
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 09 Feb 2015 06:29:11 GMT
+      Server:
+      - Apache/2.2.14 (Ubuntu)
+      Set-Cookie:
+      - CAKEPHP=fa3qh0ie5k6u1bkd0c4f4pkjg2; expires=Mon, 09-Feb-2015 09:49:12 GMT;
+        path=/; secure
+      P3p:
+      - CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store, no-cache, max-age=0, must-revalidate
+      Content-Length:
+      - '81'
+      Content-Type:
+      - text/x-json
+    body:
+      encoding: UTF-8
+      string: '{"result":{"http_status":{"code":201,"message":"Created"},"User":{"id":"20712"}}}'
+    http_version: 
+  recorded_at: Mon, 09 Feb 2015 06:29:12 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gro_social
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -172,6 +172,7 @@ files:
 - vcr_cassettes/GroSocial_Client/_request/with_options_to_GET_all_Users/returns_a_parsed_JSON_response.yml
 - vcr_cassettes/GroSocial_Users/_/returns_a_GroSocial_User_when_one_exists.yml
 - vcr_cassettes/GroSocial_Users/_/returns_nil_when_a_User_does_not_exist.yml
+- vcr_cassettes/GroSocial_Users/creating_a_user.yml
 homepage: https://github.com/BaseCampOps/gro_social
 licenses:
 - MIT
@@ -211,3 +212,4 @@ test_files:
 - vcr_cassettes/GroSocial_Client/_request/with_options_to_GET_all_Users/returns_a_parsed_JSON_response.yml
 - vcr_cassettes/GroSocial_Users/_/returns_a_GroSocial_User_when_one_exists.yml
 - vcr_cassettes/GroSocial_Users/_/returns_nil_when_a_User_does_not_exist.yml
+- vcr_cassettes/GroSocial_Users/creating_a_user.yml