stbaldricks 4.5.0 → 4.5.1.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53c2d07ee4c230a689311946fa5429514022200b404121a67d312bea8cea8300
-  data.tar.gz: 1f77fadca3cee1b606ad35a1b631466feeaf664113c045e7fb581361a37ee476
+  metadata.gz: 8aee495073a0386c3ac288ef9f754c0730a341cceeade3d2ee19827f8ac40564
+  data.tar.gz: c173494aba2b397fa847e663d6a1ffede523783998cc2ce0696f20c18ff8aefc
 SHA512:
-  metadata.gz: 3759276e30a880ff1405a19499c682915aec6ff07d1dc02d28f75b9b890aff77895e0ac33a75531d297a3625f4337968a2c998c1a6478e1d420b0f86fca07ef3
-  data.tar.gz: d1b75e4ec182a9c5ec0e83facea056316f833b3ba84f99d2006bf85503c0261c0d780054a29b7fa5c49c8e665bfbd2e73860103163a26eae25555936e3f41d12
+  metadata.gz: b14d4b72c4fe55a01559462712f997cc6ccec1ae91739e5fedbe0f349b454699298865b7d6ae21fdd148adf7ed0d4b9dd92cc89b4ad1bcc1a673412c1aaad9f2
+  data.tar.gz: 3f1a1433db08393ca97d870a1ae901af2d275a9c0ab4ac5bae3aacafb35590494e9829e096ef0540dba900ce08f88f1089e7c66093f2abfb68acf0d63c8bb283

data/README.md

@@ -4,7 +4,7 @@
 `gem install stbaldricks`
 
 ### Configuration
-* The sdk is configured using environment variables.
+* The SDK is configured using environment variables.
 * Required configurations:
 ```
 API_ENDPOINT="https://stbaldricks.org/api"
@@ -18,7 +18,7 @@ API_KEY="abc123"
 * Configure the log level (optional)
 `SBF::Client::Configuration.logger.level = ::Logger::WARN`
 
-* **NOTE** the sdk does not raise execptions for failed requests. This is to allow for more complex logic around error scenarios.
+* **NOTE** the SDK does not raise exceptions for failed requests. This is to allow for more complex logic around error scenarios.
     * If you would like the client to raise errors by default you can wrap your requests in a helper
 ``` ruby
 def request_helper
@@ -48,7 +48,7 @@ active_donation_count = request_helper {
 puts "Beginning number of active donations: #{active_donation_count[:id]}"
 ```
 
-* Use `get` to get an entity by it's id fields
+* Use `get` to get an entity by its id fields
 ``` ruby
 existing_donation = request_helper { SBF::Client::Donation.get(188) }
 puts "Donation: #{JSON.pretty_generate(existing_donation.to_hash)}"
@@ -118,10 +118,10 @@ puts JSON.pretty_generate(participants_and_fundraisers)
 
 ##### Filtered Search
 ``` ruby
-# Find all active events, teams, and fundraisers at the railyard event
+# Find all active participants, teams, and fundraisers at the railyard event
 railyard_event = request_helper { SBF::Client::Event.find(venue: {location: {name: {like: "%Rail%"}}}, year: 2017) }[:results].first
 
-model_types = [SBF::Client::Search::Type::EVENT, SBF::Client::Search::Type::TEAM, SBF::Client::Search::Type::FUNDRAISER]
+model_types = [SBF::Client::Search::Type::PARTICIPANT, SBF::Client::Search::Type::TEAM, SBF::Client::Search::Type::FUNDRAISER]
 filter = {
   and: [
     {column: 'status_id', operator: 'equals', value: SBF::Client::Search::Status::ACTIVE},
@@ -141,7 +141,7 @@ require 'geocoder'
 data = Geocoder::Lookup.get(:google).search("Lincoln, NE").first
 lat = data.latitude.round(6)
 lon = data.longitude.round(6)
-geo_location = {lat: lat, lon: lon, distance: 200}
+geo_location = {lat: lat, lon: lon, distance: 10}
 
 model_type = SBF::Client::Search::Type::PARTICIPANT
 
@@ -151,3 +151,41 @@ active_participant_within_10_mi = request_helper { SBF::Client::Search.find(mode
 puts JSON.pretty_generate(active_participant_within_10_mi)
 ```
 
+## Architecture
+| Component          | Location
+|--------------------|------------------------------|
+| Endpoints          | `/lib/stbaldricks/endpoints` |
+| Entities           | `/lib/stbaldricks/entities`  |
+| Enums              | `/lib/stbaldricks/enums`     |
+| Rspec Unit         | `/spec/unit`                 |
+| Rspec Integration  | `/spec/integration`          |
+
+### Endpoints
+* Define supported requests that can be made to the SBF API for entities in the client library.
+* Extend `SBF::Client::EntityEndpoint` to receive common core action for the entities.
+  * If additional or non-standard functionality is required, actions can be added or overridden.
+* Return a response object which will contain an http status code and depending on the code either error details
+or the expected API response data for a successful request.
+
+### Entities
+* Object representations of the data sent to and received from the API.
+* Top-level entities (those that can be directly requested or modified via the API) inherit from `SBF::Client::TopLevelEntity`.
+  * Supported actions on the entity are defined via `action` and `actions`.
+  * Any actions that are disallowed are blocked via `blacklist_action`.
+  * The entities also map to their corresponding endpoint for handling all related API requests.
+* Sub-entities should still extend the `SBF::Client::BaseEntity`.
+
+### Enums
+* Collections of constants to assist with specifying values within a finite list.
+
+### Rspec Tests
+Tests are broken out into unit and integration tests. Test coverage thresholds are enforced and test additions or modifications are
+required for nearly any client library change.
+
+More detail on understanding and writing Rspec tests can be found in the [Rspec Guide](https://github.com/firespring/sbf/tree/master/documentation/guides/rspec).
+
+#### Running Tests
+* use `rake client:ruby:test:all` to run all tests
+* use `rake client:ruby:test:integration` to run all integration tests
+* use `rake client:ruby:test:unit` to run all unit tests
+* use `rake client:ruby:test:rspec TESTS={path-to-test}` to run specific test(s)

data/lib/stbaldricks/endpoints/facebook/user.rb

@@ -0,0 +1,37 @@
+require 'stbaldricks/endpoints/user'
+
+module SBF
+  module Client
+    module Facebook
+      class UserEndpoint < SBF::Client::UserEndpoint
+        # Logs in a user, using a Facebook Oauth authorization code & redirect uri.
+        # Configures the client library to use user credentials for subsequent requests.
+        # Returns the SBF access token for the user that should be held onto to configure the client library in
+        # future requests that are outside of this scope.
+        #
+        # @param authorization_code [string]
+        # @param redirect_uri [string]
+        # @return [string]
+        def login!(authorization_code, redirect_uri)
+          response = SBF::Client::Api::Request.post_request(
+              "/#{SBF::Client::Api::VERSION}/security/facebook/login",
+              authorization_code: authorization_code,
+              redirect_uri: redirect_uri
+          )
+          parsed_response = JSON.parse(response.body).symbolize!
+
+          if ok?(response)
+            SBF::Client::Configuration.user_token = parsed_response[:token]
+            data = parsed_response.merge(user: target_class.new(parsed_response[:user]))
+            SBF::Client::LOG.info { "SBF::Client - Facebook User Login with Identifier: #{parsed_response[:user][:identifier]}" }
+          else
+            SBF::Client::Configuration.user_token = nil
+            error = SBF::Client::ErrorEntity.new(parsed_response)
+          end
+
+          SBF::Client::Api::Response.new(http_code: response.code, data: data, error: error)
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/endpoints/user.rb

@@ -67,13 +67,11 @@ module SBF
           password: password
         )
 
-        if ok?(response)
-          SBF::Client::Configuration.user_token = nil
-        else
-          SBF::Client::Configuration.user_token = nil
+        unless ok?(response)
           parsed_response = JSON.parse(response.body).symbolize!
           error = SBF::Client::ErrorEntity.new(parsed_response)
         end
+        SBF::Client::Configuration.user_token = nil
 
         SBF::Client::LOG.info { "SB::Client - Change Password for user with profile_id: #{profile_id}" }
         SBF::Client::Api::Response.new(http_code: response.code, data: nil, error: error)

data/lib/stbaldricks/entities/facebook/user.rb

@@ -0,0 +1,12 @@
+require 'stbaldricks/entities/user'
+require 'stbaldricks/endpoints/facebook/user'
+
+module SBF
+  module Client
+    module Facebook
+      class User < SBF::Client::User
+        endpoint SBF::Client::Facebook::UserEndpoint
+      end
+    end
+  end
+end

data/lib/stbaldricks/version.rb

@@ -1,5 +1,5 @@
 module SBF
   module Client
-    VERSION = '4.5.0'
+    VERSION = '4.5.1.alpha.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stbaldricks
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.1.alpha.1
 platform: ruby
 authors:
 - Firespring
@@ -85,6 +85,7 @@ files:
 - lib/stbaldricks/endpoints/contact.rb
 - lib/stbaldricks/endpoints/event.rb
 - lib/stbaldricks/endpoints/event_application.rb
+- lib/stbaldricks/endpoints/facebook/user.rb
 - lib/stbaldricks/endpoints/fund.rb
 - lib/stbaldricks/endpoints/kid.rb
 - lib/stbaldricks/endpoints/kid_honor.rb
@@ -139,6 +140,7 @@ files:
 - lib/stbaldricks/entities/event_donation_summary.rb
 - lib/stbaldricks/entities/event_participant_summary.rb
 - lib/stbaldricks/entities/event_supporter.rb
+- lib/stbaldricks/entities/facebook/user.rb
 - lib/stbaldricks/entities/fund.rb
 - lib/stbaldricks/entities/fundraiser.rb
 - lib/stbaldricks/entities/grant.rb
@@ -217,9 +219,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.5