harbourmaster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9db5aee903e9de879c9533ba8682387e34be4b0
+  data.tar.gz: 2e628fbb6d88224da55360922507d545bd92c035
+SHA512:
+  metadata.gz: 9004d32100873aeea63ec0b5920f1bb72ef4cebb1cb899b7c2eb48210accca05674864bac3915b3d211663121d24c4db276c2358e723aab3782cb54800e4c8ed
+  data.tar.gz: d9fcc8c8f5b8a43c9c4ce78a1eb2e3938934a65bef6f4a14c96411cbf5ef1753ce89f394ba472ac49b1797b131b7380529cb5c4fa5e63beb4a32e6ae3d62c281

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Isaac Norman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Harbourmaster
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Harbourmaster'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/harbourmaster/controller/controller_generator.rb

@@ -0,0 +1,21 @@
+module Harbourmaster
+  class ControllerGenerator < Rails::Generators::NamedBase
+    desc 'Used to create a documented API controller'
+    argument :api_base_route, type: :string, default: "app/controllers/api"
+    class_option :permit_params, type: :boolean, desc: "When included will generate a permitted_params method in the controller"
+    class_option :actions, type: :array, aliases: '-a', desc: "List of controller actions to generate"
+    source_root File.expand_path('../templates', __FILE__)\
+
+    def create_controller_file
+      template 'controller.rb', "#{api_base_route}/#{plural_name}_controller.rb"
+    end
+
+    def create_acceptance_tests
+      template 'acceptance_tests.rb', "spec/acceptance/#{plural_name}_spec.rb" if options['actions']
+    end
+
+    def create_serializer
+      template 'serializer.rb', "app/serializers/#{name.underscore}_serializer.rb"
+    end
+  end
+end

data/lib/generators/harbourmaster/controller/templates/acceptance_tests.rb

@@ -0,0 +1,76 @@
+require "rails_helper"
+require "rspec_api_documentation/dsl"
+
+resource "<%= name.camelize %>" do
+  before do
+    @<%= name.underscore -%> = create(:<%= name.underscore -%>)
+  end
+
+  <%- if options["actions"].include? "index" -%>
+  # get INDEX docs
+  get "/<%= plural_name -%>" do
+
+    example "Listing <%= plural_name -%>" do
+      do_request
+
+      expect(status).to eq 200
+    end
+
+    parameter :name, "Name of the last record on the previous page", required: false, scope: :from
+    let(:name) { "b" }
+    example "Listing <%= plural_name -%> from the letter B (pagination)" do
+      explanation "This uses the paginative gem for pagination by showing only the records after the record you pass in."
+
+      expect(params).to eq({ from: { name: "b" } }.as_json)
+    end
+  end
+  <%- end -%>
+
+  <%- if options["actions"].include? "show" -%>
+  # get SHOW docs
+  get "/<%= plural_name -%>/:id" do
+    let(:id) { @<%= name.underscore -%>.id }
+
+    example "Get a specific <%= name.underscore %>" do
+      do_request
+
+      expect(status).to eq 200
+    end
+  end
+  <%- end -%>
+
+  <%- if options["actions"].include? "create" -%>
+  # post CREATE docs
+  post "/<%= plural_name -%>" do
+    example "Creating a <%= name.underscore %>" do
+      do_request(<%= name.underscore %>: @<%= name.underscore -%>.attributes.except("id", "created_at").as_json)
+
+      expect(status).to eq 201
+    end
+  end
+  <%- end -%>
+
+  <%- if options["actions"].include? "update" -%>
+  put "/<%= plural_name -%>/:id" do
+    let(:id) { @<%= name.underscore -%>.id }
+
+    example "Updating a specific <%= name.underscore -%>" do
+      do_request(<%= name.underscore %>: @<%= name.underscore -%>.attributes.except("created_at").as_json)
+
+      expect(status).to eq 200
+    end
+  end
+  <%- end -%>
+
+  <%- if options["actions"].include? "destroy" -%>
+  delete "/<%= plural_name %>/:id" do
+    let(:id) { @<%= name.underscore %>.id }
+
+    example "Deleting a specific <%= name.underscore %>" do
+      do_request
+
+      expect(status).to eq 204
+    end
+  end
+  <%- end -%>
+end

data/lib/generators/harbourmaster/controller/templates/controller.rb

@@ -0,0 +1,12 @@
+class <%= plural_name.camelize %>Controller < BaseApiController
+  <%= "actions :#{options['actions'].join(', :') }" if options['actions'].present? -%>
+
+<% if options['permit_params'] -%>
+
+  private
+
+  def permitted_params
+    params.require(:<%= name.underscore -%>).permit(:<%= (class_name.constantize.new.attribute_names - ["created_at", "updated_at"]).join(', :') %>)
+  end
+<% end -%>
+end

data/lib/generators/harbourmaster/controller/templates/serializer.rb

@@ -0,0 +1,3 @@
+class <%= class_name -%>Serializer < ActiveModel::Serializer
+  attributes :<%= (class_name.constantize.new.attribute_names).join(', :') %>
+end

data/lib/generators/harbourmaster/install/install_generator.rb

@@ -0,0 +1,27 @@
+module Harbourmaster
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Creates a base api controller from which all other controllers will inherit. Also generates the serializer initializer.'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_base_api_controller
+      copy_file 'base_api_controller.rb', 'app/controllers/base_api_controller.rb'
+    end
+
+    def initializer_responder
+      template 'json_responder.rb', 'lib/responders/json_responder.rb'
+    end
+
+    def initialize_active_model_serializers
+      copy_file 'active_model_serializer.rb', 'config/initializers/active_model_serializer.rb'
+    end
+
+    def initialize_api_docs
+      copy_file 'rspec_api_documentation.rb', 'config/initializers/rspec_api_documentation.rb'
+    end
+
+    def initialize_apitome
+      generate "apitome:install"
+    end
+  end
+end

data/lib/generators/harbourmaster/install/templates/active_model_serializer.rb

@@ -0,0 +1,4 @@
+ActiveModel::Serializer.setup do |config|
+  config.embed = :ids
+  config.embed_in_root = true
+end

data/lib/generators/harbourmaster/install/templates/base_api_controller.rb

@@ -0,0 +1,28 @@
+require 'json_responder'
+
+class BaseApiController < InheritedResources::Base
+  respond_to :json
+  responders :json
+
+  def collection
+    limit_per_page = params[:per_page] || nil
+    @q = end_of_association_chain
+    @q = @q.search(params[:q])
+    @q = @q.result
+
+    @total_count = @q.length
+    limit_per_page ||= @total_count
+
+    # Pagination
+    if params[:from]
+      @q = @q.with_name_from(params[:from][:name], limit_per_page) if params[:from][:name]
+      @q = @q.with_field_from(params[:from][:field], params[:from][:value]) if params[:from][:field]
+    end
+
+    @q.limit(limit_per_page)
+  end
+
+  def default_serializer_options
+    { meta: { deleted_ids: end_of_association_chain.show_deleted_ids(params[:visible_ids]), pagination: { total_objects: @total_count } } }
+  end
+end

data/lib/generators/harbourmaster/install/templates/json_responder.rb

@@ -0,0 +1,35 @@
+<%- if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2 -%>
+# Conform to http://jsonapi.org/format/ by returning the updated object from a PUT instead of HTTP spec's default of 204.
+module Responders::JsonResponder
+  protected
+
+  # simply render the resource even on POST instead of redirecting for ajax
+  def api_behavior
+    if post?
+      display resource, status: :created
+    # render resource instead of 204 no content
+    elsif put?
+      display resource, status: :ok
+    else
+      super
+    end
+  end
+end
+<%- else -%>
+# Conform to http://jsonapi.org/format/ by returning the updated object from a PUT instead of HTTP spec's default of 204.
+module Responders::JsonResponder
+  protected
+
+  # simply render the resource even on POST instead of redirecting for ajax
+  def api_behavior(error)
+    if post?
+      display resource, status: :created
+    # render resource instead of 204 no content
+    elsif put?
+      display resource, status: :ok
+    else
+      super
+    end
+  end
+end
+<%- end -%>

data/lib/generators/harbourmaster/install/templates/rspec_api_documentation.rb

@@ -0,0 +1,69 @@
+# Values listed are the default values
+RspecApiDocumentation.configure do |config|
+  # Set the application that Rack::Test uses
+  config.app = Rails.application
+
+  # Output folder
+  config.docs_dir = Rails.root.join("doc", "api")
+
+  # An array of output format(s).
+  # Possible values are :json, :html, :combined_text, :combined_json,
+  #   :json_iodocs, :textile, :markdown, :append_json
+  config.format = [:json]
+
+  # Location of templates
+  config.template_path = "inside of the gem"
+
+  # Filter by example document type
+  config.filter = :all
+
+  # Filter by example document type
+  config.exclusion_filter = nil
+
+  # Used when adding a cURL output to the docs
+  config.curl_host = nil
+
+  # Used when adding a cURL output to the docs
+  # Allows you to filter out headers that are not needed in the cURL request,
+  # such as "Host" and "Cookie". Set as an array.
+  config.curl_headers_to_filter = nil
+
+  # By default, when these settings are nil, all headers are shown,
+  # which is sometimes too chatty. Setting the parameters to an
+  # array of headers will render *only* those headers.
+  config.request_headers_to_include = nil
+  config.response_headers_to_include = nil
+
+  # By default examples and resources are ordered by description. Set to true keep
+  # the source order.
+  config.keep_source_order = false
+
+  # Change the name of the API on index pages
+  config.api_name = "API Documentation"
+
+  # Redefine what method the DSL thinks is the client
+  # This is useful if you need to `let` your own client, most likely a model.
+  config.client_method = :client
+
+  # Change the IODocs writer protocol
+  config.io_docs_protocol = "http"
+
+  # You can define documentation groups as well. A group allows you generate multiple
+  # sets of documentation.
+  config.define_group :public do |config|
+    # By default the group's doc_dir is a subfolder under the parent group, based
+    # on the group's name.
+    config.docs_dir = Rails.root.join("doc", "api", "public")
+
+    # Change the filter to only include :public examples
+    config.filter = :public
+  end
+
+  # Change how the post body is formatted by default, you can still override by `raw_post`
+  # Can be :json, :xml, or a proc that will be passed the params
+  config.post_body_formatter = Proc.new { |params| params }
+
+  # Change the embedded style for HTML output. This file will not be processed by
+  # RspecApiDocumentation and should be plain CSS.
+  config.html_embedded_css_file = nil
+end

data/lib/harbourmaster/version.rb

@@ -0,0 +1,3 @@
+module Harbourmaster
+  VERSION = "0.1.0"
+end

data/lib/harbourmaster.rb

@@ -0,0 +1,10 @@
+require "rspec"
+require "rspec_api_documentation"
+require "active_model_serializers"
+require "inherited_resources"
+require "apitome"
+require "responders"
+require "ransack"
+
+module Harbourmaster
+end

data/lib/tasks/harbourmaster_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :harbourmaster do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: harbourmaster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaac Norman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rspec_api_documentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: inherited_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: ragamuffins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: paginative
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.18
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: apitome
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails generator for making documented API controllers
+email:
+- idn@papercloud.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/harbourmaster/controller/controller_generator.rb
+- lib/generators/harbourmaster/controller/templates/acceptance_tests.rb
+- lib/generators/harbourmaster/controller/templates/controller.rb
+- lib/generators/harbourmaster/controller/templates/serializer.rb
+- lib/generators/harbourmaster/install/install_generator.rb
+- lib/generators/harbourmaster/install/templates/active_model_serializer.rb
+- lib/generators/harbourmaster/install/templates/base_api_controller.rb
+- lib/generators/harbourmaster/install/templates/json_responder.rb
+- lib/generators/harbourmaster/install/templates/rspec_api_documentation.rb
+- lib/harbourmaster.rb
+- lib/harbourmaster/version.rb
+- lib/tasks/harbourmaster_tasks.rake
+homepage: https://github.com/Papercloud/Harbourmaster
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Take control of your doc(k)s
+test_files: []