plangrade-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f586e34e9b14bdbf1876bf3ef5a529796c851ac7
-  data.tar.gz: 26ddeaa6b6ede4f906b6e3373b19530f55fa8836
+  metadata.gz: cc572cab1e6af8ce319b06155cf5b6edd1b5f352
+  data.tar.gz: 310463d189fc5303354684acbc3d46325410019a
 SHA512:
-  metadata.gz: 1df7976f370ea8d7efa29844e5b4e4158ac3c4e72aa11ba2e33f0d17e03d9156288fb3231a801916fae78811edbf89d3ced681e35ee613b6e4f7841357580429
-  data.tar.gz: d333fce2d7a39b241eda7480ab5e382cb18634baa47e1675e7d757eb0615d6d05ede65af02a81b962f2c2f8bff73f550d26588bfd26da0353569ea714293960e
+  metadata.gz: 6ce5f3d654cf231b1bbdf6b372c510aed155a62bf5e893dc88b198835998e7aba088e69c94cc35fb84a9f22057467824c32438675c78fdd101fdcbb09bf5a660
+  data.tar.gz: 77bf79a9c3d654df0e5ad41dcd175b91cc406703bae7713422dbdf6ecfded2d23ef5c4986efac101954b23f1f701d3ee4cc7f0e5ead6d2d5b7cb196a4701a77e

checksums.yaml.gz.sig

@@ -1,3 +1 @@
-����Vׁ�����
-�o����!ma<�
-Y�m�J�� �
�����}8�tw6<o���"�/9��G���(�B�V�.��-!�f��9�~w�I�H�7����(O�/[���v���M
+���M�ު�����j��e�������փl�2,ѓ%����C|�dHMe�����i�/�y�@���G%�[-ګ}�3�s���|�7�DJ��.��[��U��#�;W}�%�"C������=J���	��L��j�z�~�]�I��g���2�yS��U�����i3�����]���r���|*Ӟ[��o�8,cW���S�';�C6��A|�D�p�N��u���ZD� ��S�-/�S/o��Z��S�g�B�T+�

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby
 
 branches:
   only:

data/README.md

@@ -1,6 +1,8 @@
 # plangrade API Gem
 [![Gem Version](https://badge.fury.io/rb/plangrade-ruby.svg)](http://badge.fury.io/rb/plangrade-ruby)
 [![Code Climate](https://codeclimate.com/github/topherreynoso/plangrade-ruby/badges/gpa.svg)](https://codeclimate.com/github/topherreynoso/plangrade-ruby)
+[![Coverage Status](https://coveralls.io/repos/topherreynoso/plangrade-ruby/badge.png?branch=master)](https://coveralls.io/r/topherreynoso/plangrade-ruby?branch=master)
+[![Build Status](https://travis-ci.org/topherreynoso/plangrade-ruby.svg?branch=master)](https://travis-ci.org/topherreynoso/plangrade-ruby)
 
 Ruby wrapper for the plangrade API.
 
@@ -103,10 +105,11 @@ At this point the `access_token` is nil. This will need to be set and, in the ne
 
 ## Usage
 
-This gem offers two way to interact with plangrade's API:
+This gem offers three ways to interact with plangrade's API:
 
-1. Calling methods on `Plangrade` module.
-2. Calling methods on an instance of `Plangrade::Client`.
+1. Calling methods on `Plangrade` module. (Returns an API response)
+2. Calling methods on an instance of `Plangrade::Client`. (Returns an API response)
+3. Calling methods on the custom object models. (Returns identity mapped objects)
 
 ### Calling methods on the plangrade module
 
@@ -230,6 +233,50 @@ Delete participant
 plangrade.delete_participant(id)
 ```
 
+### Using the object models
+
+The object model is an abstraction that makes it easy to manipulate the JSON data return when accessing plangrade's API. Each model has accessor methods for all keys contained in the JSON response for a given model type.
+
+**Users**
+
+```ruby
+user_id = Plangrade::Resources::User.create(user_email_here, user_name_here)
+user = Plangrade::Resouces::User.current_user
+user.name
+user.email
+user.update!(:email => "compliance@plangrade.com")
+user.delete!
+```
+
+**Companies**
+
+```ruby
+company_id = Plangrade::Resources::Company.create(company_ein_here, company_name_here)
+companies = Plangrade::Resources::Company.all
+company = Plangrade::Resources::Company.get(company_id)
+company.name
+company.ein
+company.grade
+company.update!(:name => "plangrade, llc")
+company.delete!
+```
+
+**Patricipants**
+```ruby
+participants = Plangrade::Resources::Participant.all
+participant_id = Plangrade::Resources::Participant.create(company_id, first_name, last_name, 
+														  street1, street2, city, state, zip, 
+														  dob, ssn, email, phone, employee_id)
+participant = Plangrade::Resources::Participant.get(participant_id)
+participant.first_name
+participant.last_name
+participant.company_id
+...
+participant.update!(:first_name => "Johnny")
+participant.archive!
+participant.delete!
+```
+
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against](https://travis-ci.org/topherreynoso/plangrade-ruby) the following Ruby versions:
@@ -237,7 +284,6 @@ This library aims to support and is [tested against](https://travis-ci.org/tophe
 1. Ruby 1.9.3
 2. Ruby 2.0.0
 3. Ruby 2.1.0
-4. jruby
 
 This library may inadvertently work (or seem to work) on other Ruby implementations, however, support will only be provided for the versions listed above.
 

data/lib/plangrade/resources/company.rb

@@ -11,6 +11,18 @@ module Plangrade
 
       attr_accessor_deffered :name, :ein, :grade
 
+      def self.get(id)
+        api_handler.get_company(id)
+        return nil unless result.success?
+        new(result.body[:company])
+      end
+
+      def self.all(params)
+        api_handler.all_companies(params)
+        return nil unless result.success?
+        new(result.body[:companies])
+      end
+
       def update!(params)
         api_handler.update_company(@id, params)
       end

data/lib/plangrade/resources/participant.rb

@@ -3,18 +3,32 @@ module Plangrade
     class Participant < Plangrade::Resources::Base
 
       def self.create(company_id, first_name, last_name, street1, street2, city, state, zip, dob, ssn, email, phone, employee_id)
-
-        result = api_handler.create_participant(:company_id => company_id, :first_name => first_name, :last_name => last_name,
-                                                :street1 => street1, :street2 => street2, :city => city, :state => state,
-                                                :zip => zip, :dob => dob, :ssn => ssn, :email => email, :phone => phone,
-                                                :employee_id => employee_id)
+        result = api_handler.create_participant(:company_id => company_id, :first_name => first_name, :last_name => last_name, :street1 => street1, :street2 => street2, :city => city, :state => state,
+                                                :zip => zip, :dob => dob, :ssn => ssn, :email => email, :phone => phone, :employee_id => employee_id)
         return nil unless result.created?
         id = result.headers[:location].split('/').last.to_i
         new(:id => id)
       end
 
-      attr_accessor_deffered :company_id, :employee_id, :first_name, :last_name, :street1, :street2, :city, :state, :zip,
-      :dob, :ssn, :email, :phone
+      attr_accessor_deffered :company_id, :employee_id, :first_name, :last_name, :street1, :street2, :city, :state, :zip, :dob, :email, :phone
+
+      def self.get(id)
+        api_handler.get_participant(id)
+        return nil unless result.success?
+        new(result.body[:participant])
+      end
+
+      def self.all(params)
+        api_handler.all_participants(params)
+        return nil unless result.success?
+        new(result.body[:participants])
+      end
+
+      def archive!
+        api_handler.archive_participant(@id)
+        return nil unless result.success?
+        new(result.body)
+      end
 
       def update!(params)
         api_handler.update_participant(@id, params)

data/lib/plangrade/ruby/version.rb

@@ -1,5 +1,5 @@
 module Plangrade
   module Ruby
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plangrade-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Christopher Reynoso