kanpachi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b32fca8beebd8f5825ae812e10da8afcc954e1e
-  data.tar.gz: e9b1afcb5063c31d7a34a00df982df90b2018444
+  metadata.gz: 8e5b6e4840bc2626d0f535c41b4b1616c68ed104
+  data.tar.gz: 6a8a37c95c72696c02a1d16584f86a2e7a52da83
 SHA512:
-  metadata.gz: 13b00d7801dcaa54c0a1ecb266cbfce68ee90f453b72c4d4fc502eb65ad4e701436906ea1e5e8dd773c14095798732484b749968aaef02b7c333d9b8052c902b
-  data.tar.gz: c522f30028ccaf62e7161b622090fb318d3df0ae86a9ae6a2c0623f44ab8558722b1e00dbca5466a7263c512f37910f2bba3b0825911f91edb4fff63499315a9
+  metadata.gz: a3b3203cf7f46001360c790ebe6737221121a43e9be71d4ea9df159c2090c60c7e22bb776f25eb497128a6dc72836a16c1684d54ab4711b044f311441114367c
+  data.tar.gz: a23863a0ce77e9774db497c11c683dc350d91adc7db3011d0c490f15313c941ce545bc46befd62a6987110467f22b0249c08f9b6a6e10763d745c001add80099

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Kanpachi Changelog
 
+## 0.0.3
+* Wrap documentation footer in a container class to pad copyright
+* Switch response roar representer to decorator. Prefer decorating objects
+rather than mutating them with `#extend`.
+
 ## 0.0.2
 
 * Add error codes and responses documentation page.

data/README.md

@@ -23,12 +23,14 @@ Below is an example of one of Twitter's API endpoints partially described in Kan
 api 'Twitter' do
   # API meta data
   title 'REST API v1.1 Resources'
-  description 'This describes the resources that make up the official Twitter API v1.1'
+  description 'This describes the resources that make up the official Twitter
+API v1.1'
   host 'api.twitter.com'
 
   # Define global error responses
   error :malformed_params do
-    description 'Sending invalid JSON will result in a 400 Bad Request response.'
+    description 'Sending invalid JSON will result in a 400 Bad Request
+response.'
 
     response do
       status 400
@@ -40,35 +42,56 @@ api 'Twitter' do
   end
 
   section 'Timelines' do
-    description 'Timelines are collections of Tweets, ordered with the most recent first.'
-
     resource :get, '/statuses/mentions_timeline' do
       name 'Mentions timeline'
-      description <<-TEXT
-Returns the 20 most recent mentions (tweets containing a users's @screen_name) for the authenticating user.
+      description <<-END
+Returns the 20 most recent mentions (tweets containing a users's @screen_name)
+for the authenticating user.
 
-The timeline returned is the equivalent of the one seen when you view [your mentions](https://twitter.com/mentions) on twitter.com.
+The timeline returned is the equivalent of the one seen when you view
+[your mentions](https://twitter.com/mentions) on twitter.com.
 
 This method can only return up to 800 tweets.
 
-See [__Working with Timelines__](https://dev.twitter.com/docs/working-with-timelines) for instructions on traversing timelines.
-TEXT
+See [__Working with Timelines__](https://dev.twitter.com/docs/working-with-timelines)
+for instructions on traversing timelines.
+      END
       versions '1.1'
       ssl true
       formats :json
 
-      # Params are a subclass of Mutations::Command
       params do
-        required do
-        end
-
         optional do
-          integer :count, doc: 'Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if `include_rts` is not supplied. It is recommended you always send `include_rts=1` when using this API method.'
-          integer :since_id, doc: 'Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.', example: 12345
-          integer :max_id, doc: 'Returns results with an ID less than (that is, older than) or equal to the specified ID.', example: 54321
-          boolean :trim_user, doc: 'When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.', example: true
-          boolean :contributor_details, doc: 'This parameter enhances the contributors element of the status response to include the screen_name of the contributor. By default only the user_id of the contributor is included.', example: true
-          boolean :include_entities, doc: 'The `entities` node will be disincluded when set to false.', example: false
+          integer :count,
+            doc: 'Specifies the number of tweets to try and retrieve, up to a
+maximum of 200. The value of count is best thought of as a limit to the number
+of tweets to return because suspended or deleted content is removed after the
+count has been applied. We include retweets in the count, even if `include_rts`
+is not supplied. It is recommended you always send `include_rts=1` when using
+this API method.'
+          integer :since_id,
+            doc: 'Returns results with an ID greater than (that is, more recent
+than) the specified ID. There are limits to the number of Tweets which can be
+accessed through the API. If the limit of Tweets has occured since the since_id,
+the since_id will be forced to the oldest ID available.',
+            example: 12345
+          integer :max_id,
+            doc: 'Returns results with an ID less than (that is, older than) or
+equal to the specified ID.',
+            example: 54321
+          boolean :trim_user,
+            doc: 'When set to either true, t or 1, each tweet returned in a
+timeline will include a user object including only the status authors numerical
+ID. Omit this parameter to receive the complete user object.',
+            example: true
+          boolean :contributor_details,
+            doc: 'This parameter enhances the contributors element of the status
+response to include the screen_name of the contributor. By default only the
+user_id of the contributor is included.',
+            example: true
+          boolean :include_entities,
+            doc: 'The `entities` node will be disincluded when set to false.',
+            example: false
         end
       end
 
@@ -80,8 +103,14 @@ TEXT
         # Response representations include Roar::Representer
         representation do
           include ::Representable::JSON::Collection
-          property :title, type: String, doc: "it's the title", example: 'The Title'
-          collection :coordinates, doc: "it's the coordinates", example: [100.4, 45.1]
+
+          property :title,
+            type: String,
+            doc: 'The title',
+            example: 'The Title'
+          collection :coordinates,
+            doc: 'The coordinates',
+            example: [100.4, 45.1]
         end
       end
     end

data/kanpachi.gemspec

@@ -19,24 +19,23 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'thor'
-  spec.add_dependency 'slim'
   spec.add_dependency 'roar'
   spec.add_dependency 'representable'
   spec.add_dependency 'mutations'
-  spec.add_dependency 'virtus', '>= 1.0.0.beta7'
+  spec.add_dependency 'virtus', '~> 1.0.0rc2'
   spec.add_dependency 'coercible'
   spec.add_dependency 'kramdown'
   spec.add_dependency 'inflecto'
-  spec.add_dependency 'middleman', '>= 3.1.5'
-  spec.add_dependency 'slim', '>= 1.3.6'
+  spec.add_dependency 'middleman', '~> 3.1.5'
+  spec.add_dependency 'slim', '~> 1.3.9'
 
   # Live-reloading plugin
-  spec.add_dependency 'middleman-livereload', '>= 3.1.0'
+  spec.add_dependency 'middleman-livereload', '~> 3.1.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'guard', '>= 2.0.0.beta.3'
+  spec.add_development_dependency 'minitest', '~> 5.0.0'
+  spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
 
   # For faster file watcher updates on Windows:

data/lib/kanpachi/commands/new.rb

@@ -10,7 +10,7 @@ module Kanpachi
       class_option :test_framework, default: :minitest
 
       def self.source_root
-        File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+        File.expand_path(File.join('..', '..', '..', 'templates'), File.dirname(__FILE__))
       end
 
       def create_app

data/lib/kanpachi/documentation/source/layouts/layout.slim

@@ -47,7 +47,8 @@ html
     = yield
     hr
       footer
-        | © #{Time.now.year}
+        .container
+          | © #{Time.now.year}
 
     /! /container
     /!

data/lib/kanpachi/response.rb

@@ -1,5 +1,5 @@
-require 'roar/representer'
-require 'roar/representer/feature/hypermedia'
+require 'roar/representer/json'
+require 'roar/decorator'
 require 'representable/json/collection'
 require 'representable/json/hash'
 
@@ -14,14 +14,14 @@ module Kanpachi
       @name = name
       @status = 200
       @headers = {}
-      @representation = Module.new { include Representation }
+      @representation = Class.new(Roar::Decorator) { include Representation }
     end
 
     module Representation
       def self.included(base)
         base.class_eval do
-          include Roar::Representer
-          include Roar::Representer::Feature::Hypermedia
+          include Roar::Representer::JSON
+          include Roar::Decorator::HypermediaConsumer
 
           def self.example
             example = Hash.new

data/lib/kanpachi/version.rb

@@ -1,3 +1,3 @@
 module Kanpachi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/full_api_spec.rb

@@ -108,12 +108,12 @@ describe 'Integration Spec' do
       u = user.new
       u.first_name = "Jack"
       u.last_name = "Chu"
-      rep = repo.new.extend(r.responses.all.first.representation)
+      rep = repo.new
       rep.title = "Hi"
       rep.id = ""
       rep.users = []
       rep.users << u
-      puts rep.to_json
+      puts r.responses.all.first.representation.new(rep).to_json
 
       puts rep
       puts r.url

data/spec/response_spec.rb

@@ -27,9 +27,10 @@ describe Kanpachi::Response do
     subject.representation.must_equal representation
   end
 
-  it 'representation is a Roar representer' do
-    subject.representation.ancestors.must_include Roar::Representer
-    subject.representation.ancestors.must_include Roar::Representer::Feature::Hypermedia
+  it 'representation is a Roar decorator' do
+    subject.representation.superclass.must_equal Roar::Decorator
+    subject.representation.ancestors.must_include Roar::Representer::JSON
+    subject.representation.ancestors.must_include Roar::Decorator::HypermediaConsumer
   end
 
   it 'representation returns properties' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanpachi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-03 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: slim
-  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: roar
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +70,16 @@ dependencies:
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta7
+        version: 1.0.0rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta7
+        version: 1.0.0rc2
 - !ruby/object:Gem::Dependency
   name: coercible
   requirement: !ruby/object:Gem::Requirement
@@ -140,42 +126,42 @@ dependencies:
   name: middleman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.5
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.3.9
 - !ruby/object:Gem::Dependency
   name: middleman-livereload
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
@@ -210,30 +196,30 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -272,7 +258,6 @@ files:
 - lib/kanpachi/api.rb
 - lib/kanpachi/api_list.rb
 - lib/kanpachi/cli.rb
-- lib/kanpachi/cli/doc.rb
 - lib/kanpachi/commands/new.rb
 - lib/kanpachi/documentation/config.rb
 - lib/kanpachi/documentation/source/errors/index.html.slim
@@ -312,13 +297,6 @@ files:
 - lib/kanpachi/response_list.rb
 - lib/kanpachi/section.rb
 - lib/kanpachi/section_list.rb
-- lib/kanpachi/templates/.gitignore
-- lib/kanpachi/templates/Gemfile
-- lib/kanpachi/templates/api/api.rb
-- lib/kanpachi/templates/api/errors.rb
-- lib/kanpachi/templates/api/posts.rb
-- lib/kanpachi/templates/api/users.rb
-- lib/kanpachi/templates/documentation/config.rb
 - lib/kanpachi/version.rb
 - spec/api_list_spec.rb
 - spec/api_spec.rb
@@ -339,6 +317,13 @@ files:
 - spec/section_list_spec.rb
 - spec/section_spec.rb
 - spec/spec_helper.rb
+- templates/.gitignore
+- templates/Gemfile
+- templates/api/api.rb
+- templates/api/errors.rb
+- templates/api/posts.rb
+- templates/api/users.rb
+- templates/documentation/config.rb
 homepage: https://github.com/kamui/kanpachi
 licenses:
 - MIT
@@ -359,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.1.7
 signing_key: 
 specification_version: 4
 summary: DSL for describing Web APIs

data/lib/kanpachi/cli/doc.rb

@@ -1,62 +0,0 @@
-ENV['MM_ROOT'] = '/Users/jack/Development/kanpachi/lib/kanpachi/doc'
-
-module Kanpachi
-  module SubCommand
-  # class CLI < Thor
-    class Doc < Thor
-      namespace :doc
-
-      desc "doc:generate_doc API_NAME, SOURCE_PATH DESTINATION_PATH", "Generate HTML documentation for Kanpachi web services"
-      def generate_doc(api_name, source_path, destination_path="doc")
-        puts "Starting"
-        api_files = Dir.glob(File.join(destination_root, source_path, "**", "*.rb"))
-        if api_files.empty?
-          puts "No ruby files in source_path: #{File.join(destination_root, source_path)}"
-          return
-        end
-        api_files.each do |file|
-          require file
-        end
-
-        api = APIList.find(api_name)
-
-        require 'fileutils'
-        destination = File.join(destination_root, destination_path)
-        FileUtils.mkdir_p(destination) unless File.exist?(destination)
-        File.open("#{destination}/index.html", "w"){|f| f << doc_template.result(binding)}
-        puts "Documentation available there: #{destination}/index.html"
-        `open #{destination}/index.html` if RUBY_PLATFORM =~ /darwin/ && !ENV['DONT_OPEN']
-      end
-
-      private
-
-      def response_html(attrs)
-        response_template.result(binding)
-      end
-
-      def input_params_html(required, optional)
-        input_params_template.result(binding)
-      end
-
-      def input_params_template
-        file = resources.join '_input_params.erb'
-        ERB.new File.read(file)
-      end
-
-      def response_template
-        file = resources.join '_response.erb'
-        ERB.new File.read(file)
-      end
-
-      def doc_template
-        file = resources.join 'template.erb'
-        ERB.new File.read(file)
-      end
-
-      def resources
-        require 'pathname'
-        @resources ||= Pathname.new(File.join(File.dirname(__FILE__), 'doc_generator'))
-      end
-    end
-  end
-end