token_auth 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6252bfa11b50c55c70e0c8dc59991fa071ee78fb
-  data.tar.gz: d2fea9c3ae437c79b9ee345afa83861e7818a5a8
+  metadata.gz: 232244e546411d92fe37b5d62ce8dbd9102527af
+  data.tar.gz: cabdfa4d6502fb6608fd7c330eebb7d8b1a4d209
 SHA512:
-  metadata.gz: e888b76edec9ff0d18296ba9fb8f1affb9257129645960b2b1910c88db064a6b88e064edd26085769750cd2efad5cad00068d3fbcc72454d911bfb1fccb2d385
-  data.tar.gz: 512c09001531c69cf0d536f4ffd340908538334a4ff6d56ecb2a4cf3109b1cb1081e325345fb8cdc88ae026c23618227dc874164bc0020a54f663622bac7cd50
+  metadata.gz: 4d8efdc271760d000161832ad77bcea5f010f68d4b85f07e743d6c74b1dae2d075efffebfb6e0daab815992a69ce885689dea86e1f43656e38e5526f63320de8
+  data.tar.gz: b87481b89a919e9400ded097034c3ed145cd647adc01e7967838dff720f776df1a1177a4d01334915c237695e58a808795966932adc49f0d7d88b70f53fdf949

data/README.md

@@ -84,6 +84,21 @@ module Api
 end
 ```
 
+If you want to include content at the top of the token configuration
+page or below it, define a `pre_content` or `post_content` method in a helper
+with a `content_for` block that defines content for `:pre_content` or
+`:post_content`:
+
+```ruby
+module ApplicationHelper
+  def pre_content
+    content_for :pre_content do
+      "test food"
+    end
+  end
+end
+```
+
 ## Testing
 
 After generating a configuration token, test authentication token generation:
@@ -92,6 +107,62 @@ After generating a configuration token, test authentication token generation:
 curl --data "data[clientUuid]=asdf&configurationToken=4C3LM9" http://localhost:3000/token_auth/api/authentication_tokens
 ```
 
+## Sample Set up with Harmonium
+
+This gem is often used in conjunction with
+[harmonium-ts](https://github.com/NU-CBITS/harmonium-ts/). Below is some more
+specific examples of set up to work with both.
+
+Every two minutes by default, Harmonium transmits changed (dirty) resources to
+the server and then polls the server for new or updated resources.
+
+The server requires some configurations that allow for these `GET` and `POST` requests:
+
+* Install the gem [token_auth_server_rails](https://github.com/NU-CBITS/token_auth_server_rails),
+* Update [Participant callback](./examples/harmonium_configurations/participant_callbacks.rb),
+* Update [Participant class](./examples/harmonium_configurations/participant.rb)
+  , and
+* Specify [syncable resources](./examples/harmonium_configurations/syncable_resources.rb)
+
+On the server, each syncable class will need a `uuid` column. Add a before
+validation such as [UuidCallbacks](./examples/harmonium_configurations/uuid_callbacks.rb)
+
+```ruby
+class Foo < ApplicationRecord
+  before_validation UuidCallbacks
+
+  validates :uuid, presence: true
+  validates :uuid, uniqueness: true
+
+  belongs_to :participant
+end
+```
+
+You will also need to serialize the data. Specify what you need in the
+`attributes` key and `id` key. An example is listed below.
+
+```ruby
+class FooSerializer < ActiveModel::Serializer
+  attributes :uuid,
+             :client_created_at,
+             :client_updated_at,
+             :bar
+
+  attribute :uuid, key: :id
+
+  def bar
+    "hello world"
+  end
+end
+```
+
+These updates (adding the `uuid` column, serializing the data, and specifying
+classes to the `pullable_resource_types` in
+[Specify syncable resources](./examples/server_configurations/syncable_resources.rb))
+will make these resources available for `GET` requests.
+
+Example: `GET "/token_auth/api/payloads?filter[updated_at][gt]=DATETIME"`:
+
 ## Development
 
 Clone the repository and install dependencies:

data/app/views/token_auth/tokens/index.html.erb

@@ -1,5 +1,6 @@
 <h2><%= t(".manage_tokens_for", default: "Manage tokens for") %> <%= @entity || @entity_id %></h2>
-
+<% pre_content if respond_to? :pre_content %>
+<%= content_for :pre_content %>
 <table class="table">
   <% unless @authentication_token %>
     <tr id="config-token">
@@ -53,3 +54,5 @@
     </tr>
   <% end %>
 </table>
+<% post_content if respond_to? :post_content %>
+<%= content_for :post_content %>

data/lib/token_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Engine version.
 module TokenAuth
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: token_auth
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Eric Carty-Fickes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -28,44 +28,58 @@ dependencies:
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.X
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Rails engine for authenticating clients anonymously.