hyperdrive 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14f62cf18a7559e936f29410ddf251bc0459eef2
-  data.tar.gz: 38f5994e09e250db0664af87242badbb39bb09c0
+  metadata.gz: 1773ebd648b23d917073080a22cdfbdc7f1db732
+  data.tar.gz: b01991fbf7b86592e493a6001a9c3855e6d9648f
 SHA512:
-  metadata.gz: bd23d6d26370771f9bab0cf2f8482b4f02d8d810816b541d28fa7478c0bc0b0fe2b8867acb295d8aeb92240ff823e1365ba570e40c826ac1e2aaf63eda656546
-  data.tar.gz: eb213755881b6e07cc8fe29947b5fed3d5b910bd6e6bff82daa35a537fe075a5ba50c49e9edb49d355e02572efd20f2ca9d099f0bb560341abdf3b3469987cb4
+  metadata.gz: 12fa4db2f3a29dde64ed725c164c8ba7368163f2d178518e7a67e999b5d24e889919668d99a16e8f3f89aeaadb5e467717c7990283560a514eb3c5be948ec0b2
+  data.tar.gz: 492dd95b6214f6a1a16cb9df13d1484879351984c0ca46c89a0fdb2d9e574212ccf506741d54ab00770fd74c4d7e451030cbcf53f6bfd2739bf832c63de7135e

data/README.md

@@ -20,18 +20,30 @@ Or install it yourself as:
 
 Proposed Syntax (WIP):
 
-    hyperdrive(:deal) do
-      name 'Deals'
-      desc 'Exclusive offers and coupons'
-
-      param :name, '50 Chars or less', required: true
-      param :start_date, 'Format: YYYY-MM-DD'
-      param :end_date, 'Format: YYYY-MM-DD'
-
-      filter :start_date
-      filter :end_date
-      filter :partner_id, required: true
-    end
+```ruby
+hyperdrive do
+  resource(:thing) do
+    name 'Thing Resource'
+    desc 'Description of Thing Resource'
+
+    # Register the params you want to allow in POST, PUT, PATCH,
+    # and DELETE requests. The :id param is auto-registered
+    # and is allowed for all requests but only required for PUT,
+    # PATCH, and DELETE requests
+    param :name, '50 Chars or less' # params are required by default
+    param :start_date, 'Format: YYYY-MM-DD', required: false
+    param :end_date, 'Format: YYYY-MM-DD', required: false
+
+    # Filters only apply to GET, HEAD and OPTIONS requests
+    # Like allowed params, :id is registered by default. Requests without an ID
+    # should return an array of 1 or more resources (that match any filters
+    # applied). Unlike allowed params, filters are not required by default.
+    filter :start_date, 'Format: YYYY-MM-DD'
+    filter :end_date, 'Format: YYYY-MM-DD'
+    filter :parent_id, 'Parent ID of Thing", required: true
+  end
+end
+```
 
 ## Project Status
 

data/lib/hyperdrive.rb

@@ -1,4 +1,7 @@
-require "hyperdrive/version"
+# encoding: utf-8
+
+require 'hyperdrive/resource'
+require 'hyperdrive/version'
 
 module Hyperdrive
   # spinning up the FTL drive

data/lib/hyperdrive/resource.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module Hyperdrive
+  class Resource
+    attr_reader :resource, :allowed_params, :filters
+    attr_accessor :name, :desc
+
+    def initialize(resource)
+      @resource = resource
+      @allowed_params = default_allowed_params
+      @filters = default_filters
+    end
+
+    def register_param(key, description, options = {})
+      options = default_param_options.merge(options)
+      @allowed_params[key] = { desc: description }.merge(options)
+    end
+
+    def register_filter(key, description, options = {})
+      options = default_filter_options.merge(options)
+      @filters[key] = { desc: description }.merge(options)
+    end
+
+    private
+
+    def default_allowed_params
+      {
+        id: { desc: 'Resource Identifier', required: %w(PUT PATCH DELETE) }
+      }
+    end
+
+    def default_param_options
+      { required: true }.freeze
+    end
+
+    def default_filters
+      {
+        id: { desc: 'Resource Identifier', required: false }
+      }
+    end
+
+    def default_filter_options
+      { required: false }.freeze
+    end
+  end
+end

data/lib/hyperdrive/version.rb

@@ -1,3 +1,3 @@
 module Hyperdrive
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/hyperdrive/resource_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Hyperdrive::Resource do
+  before do
+    @resource = Hyperdrive::Resource.new(:thing)
+  end
+
+  it "creates a new resource" do
+    @resource.resource.must_equal :thing
+  end
+
+  it "has a name" do
+    @resource.name = 'Thing'
+    @resource.name.must_equal 'Thing'
+  end
+
+  it "has a description" do
+    @resource.desc = 'Description of Thing Resource'
+    @resource.desc.must_equal 'Description of Thing Resource'
+  end
+
+  it "auto-registers the :id param" do
+    @resource.allowed_params[:id][:desc].must_equal 'Resource Identifier'
+    @resource.allowed_params[:id][:required].must_equal %w(PUT PATCH DELETE)
+  end
+
+  it "registers an allowed param" do
+    @resource.register_param(:name, "Thing's Name")
+    @resource.allowed_params[:name][:desc].must_equal "Thing's Name"
+    @resource.allowed_params[:name][:required].must_equal true
+  end
+
+  it "auto-registers the :id filter" do
+    @resource.filters[:id][:desc].must_equal 'Resource Identifier'
+    @resource.filters[:id][:required].must_equal false 
+  end
+
+  it "registers a filter" do
+    @resource.register_filter(:parent_id, 'Parent ID of Thing', required: true)
+    @resource.filters[:parent_id][:desc].must_equal 'Parent ID of Thing'
+    @resource.filters[:parent_id][:required].must_equal true
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,9 @@ lib_path = File.expand_path('../lib', __FILE__)
 require 'bundler'
 Bundler.setup(:default, ENV['RACK_ENV'])
 
+# test subject
+require 'hyperdrive'
+
 # BDD Stack
 require 'minitest/autorun'
 require "minitest-spec-context"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperdrive
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - StyleSeek Engineering
@@ -26,7 +26,9 @@ files:
 - Rakefile
 - hyperdrive.gemspec
 - lib/hyperdrive.rb
+- lib/hyperdrive/resource.rb
 - lib/hyperdrive/version.rb
+- spec/hyperdrive/resource_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/styleseek/hyperdrive
 licenses:
@@ -53,4 +55,5 @@ signing_key:
 specification_version: 4
 summary: Hypermedia State Machine
 test_files:
+- spec/hyperdrive/resource_spec.rb
 - spec/spec_helper.rb