cangaroo_endpoint_base 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ecc8e671ea559bacd80dcd6f9443cfb0745979a
-  data.tar.gz: ab1de70e27da70953e0d837a5758ddef1392b774
+  metadata.gz: 538f446a2f03323020baad74065151a667249fbe
+  data.tar.gz: 738db85b363d8a829ccca56b012bed61447e059a
 SHA512:
-  metadata.gz: 10fdab2caafb5e536c246d5ee4bec3eb81e4919787c288353980f2df7bef6e02088b0f9b6811114355e0b9d46bebfb4b3d1b77b1e57f910570021e6e4a0b041d
-  data.tar.gz: 2d414757b42ce4a0b5d5b739b9b19c75f70971fa87cc9441e321a24f0d1c797f9f16a0b75344b525b3b7c853c100990c6d9c1fb0eab7585611e802d4d1335d8d
+  metadata.gz: 5ff0f984caa8865bea4e07960fd2381413fdbf916656189c4039952e66169b4ba1d6d9622b7bc3ab0d80984bf18efc87273a8619436c84575892d87ea09c4b04
+  data.tar.gz: 65a4bbdb6fef996e4d0a7dc217a858fc4f3129a4018b2d021540d86505be016c22b2ac46f8f503170c5e5c35df0938a0f3eb42917078c96aaa5d8146754506fc

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 vendor/bundle
+*.gem

data/README.md

@@ -1,8 +1,11 @@
 # CangarooEndpointBase
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cangaroo_endpoint_base`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple gem with a application helper to easily build wombat/cangaroo endpoints for system integrations.
 
-TODO: Delete this and the text above, and describe your gem
+* Easily extract polling ranges (after, and time range) from params
+* Throw errors to Rollbar
+* Protect endpoint via HTTP basic auth
+* Reset logging context before processing action
 
 ## Installation
 
@@ -12,17 +15,36 @@ Add this line to your application's Gemfile:
 gem 'cangaroo_endpoint_base'
 ```
 
-And then execute:
+In your `.env`:
 
-    $ bundle
-
-Or install it yourself as:
+```shell
+export ENDPOINT_BASIC_AUTH_TOKEN=123123
+```
 
-    $ gem install cangaroo_endpoint_base
+This token will be used as the password for HTTP Basic authentication against this endpoint.
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# application_controller.rb
+class ApplicationController < ActionController::API
+  include CangarooEndpointBase::ApplicationControllerHelper
+end
+
+# gift_cards_controller.rb
+class GiftCardsController < ApplicationController
+  def index
+    updated_after, updated_before = poll_timestamps_from_params
+
+    gift_card_poll_manager = GiftCardPollManager.new
+    gift_card_poll_manager.poll(GiftCard, last_poll: updated_after, updated_before: updated_before)
+
+    render json: { gift_cards: gift_card_poll_manager.updated_gift_cards }
+  end
+
+end
+
+```
 
 ## Development
 
@@ -33,4 +55,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cangaroo_endpoint_base.
-

data/lib/cangaroo_endpoint_base.rb

@@ -1,5 +1,6 @@
 require "cangaroo_endpoint_base/version"
 require 'cangaroo_endpoint_base/application_controller_helper'
+require 'cangaroo_endpoint_base/user_error'
 
 require 'simple_structured_logger'
 

data/lib/cangaroo_endpoint_base/application_controller_helper.rb

@@ -8,16 +8,22 @@ module CangarooEndpointBase
 
       http_basic_authenticate_with(
         name: '',
+        # TODO this should be a gem-level config
         password: ENV['ENDPOINT_BASIC_AUTH_TOKEN']
       )
 
       before_action :reset_context
 
       rescue_from StandardError do |exception|
+        # NOTE throw exceptions in test, otherwise failing tests won't fail loudly
+        if Rails.env.test? && exception.class != CangarooEndpointBase::UserError
+          raise(exception)
+        end
+
         Rollbar.error(exception) if defined?(::Rollbar)
 
         render json: { :error => exception.message }, status: :internal_server_error
-      end if !Rails.env.test?
+      end
     end
 
     protected
@@ -26,7 +32,28 @@ module CangarooEndpointBase
         log.reset_context!
       end
 
-      def last_poll_from_params
+      def poll_timestamps_from_params
+        updated_before = updated_before_from_params_or_now
+
+        updated_after = last_poll_from_params(allow_any: updated_before.present?)
+
+        return if updated_after.nil?
+
+        if updated_after >= updated_before
+          render json: "updated_since later than updated_before", status: :bad_request
+          return
+        end
+
+        [updated_after, updated_before]
+      end
+
+      def updated_before_from_params_or_now
+        return DateTime.now if params[:updated_before].nil?
+
+        Time.at(params[:updated_before].to_i).to_datetime
+      end
+
+      def last_poll_from_params(allow_any: false)
         last_poll = Time.at(params[:last_poll].to_i).to_datetime rescue nil
 
         if last_poll.nil?
@@ -34,7 +61,8 @@ module CangarooEndpointBase
           return
         end
 
-        if Rails.env.production? && last_poll < 2.week.ago
+        # TODO the env based limitation should be optional
+        if !allow_any && Rails.env.production? && last_poll < 2.week.ago
           render json: "last poll should never be more than two weeks in the past", status: :bad_request
           return
         end

data/lib/cangaroo_endpoint_base/user_error.rb

@@ -0,0 +1,5 @@
+module CangarooEndpointBase
+  class UserError < ::StandardError
+
+  end
+end

data/lib/cangaroo_endpoint_base/version.rb

@@ -1,3 +1,3 @@
 module CangarooEndpointBase
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cangaroo_endpoint_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Bianco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_structured_logger
@@ -97,6 +97,7 @@ files:
 - lib/cangaroo_endpoint_base.rb
 - lib/cangaroo_endpoint_base/application_controller_helper.rb
 - lib/cangaroo_endpoint_base/spec/spec_helper.rb
+- lib/cangaroo_endpoint_base/user_error.rb
 - lib/cangaroo_endpoint_base/version.rb
 homepage: https://github.com/iloveitaly/cangaroo_endpoint_base
 licenses: []
@@ -117,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Helpers for developing a Cangaroo (Wombat replacement) endpoint