doc_smoosher 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f88819f03578660903966d440c44ed336af08ad
-  data.tar.gz: 64cae57da6df61b314a7b3f120c39e9850f53599
+  metadata.gz: bcad1868c37bd0e77fc6bc6d2ac7011a9c439dae
+  data.tar.gz: a1a94eaa5250848f8061986df9c83312d33ad90c
 SHA512:
-  metadata.gz: b33b606df65bdb52391cfb4d784c7b1fa7d9c66d5c1cef359abb79a2e5e06edce36a8fa3cecf60afa103a3ef7c1c4b348f70e4b4a9d928cf02a0679331a0dc0b
-  data.tar.gz: 43d2f407d9daa6c3fff0a05c3f7354936d54dd415d7e46fd132c613278a637e3ba3fe80f626ef6a971f90ad2d9e1055a61cba8edefbeefe9660ceba999954484
+  metadata.gz: 0e6a0bb9316c077d3f594562f54578d7dc423b7436f7c91471323428874e71d171948bcb2550845c4653349403b3e7e1c59d6159718ccee8ddaa21fd51ef4fbd
+  data.tar.gz: e5528a28c6b1063bdaeebd4b3795df93ad5dbb02d420c7226b257f8564083a440ef300c846d9ac3135c6b749a7f3a09612362f769382ac6563b4e63452bdb655

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    doc_smoosher (0.0.1)
-      active_support
-      i18n (~> 0)
+    doc_smoosher (0.1.0)
+      activesupport
       rake (~> 0)
       rest-client (~> 0)
       thor (~> 0)
@@ -11,8 +10,6 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
     activesupport (3.0.0)
     addressable (2.3.5)
     builder (3.2.2)
@@ -49,7 +46,6 @@ GEM
       rspec (>= 2.14, < 4.0)
     hashie (2.0.5)
     highline (1.6.20)
-    i18n (0.6.9)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/doc_smoosher.gemspec

@@ -0,0 +1,131 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: doc_smoosher 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "doc_smoosher"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Joran Kikke"]
+  s.date = "2014-02-25"
+  s.description = " A simple API documentation generator for the complicated world we live in "
+  s.email = "joran.k@gmail.com"
+  s.executables = ["smoosher"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".ruby-gemset",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/smoosher",
+    "doc_smoosher.gemspec",
+    "examples/ingenia/ingenia.rb",
+    "examples/ingenia/ingenia_webapp.rb",
+    "examples/ingenia/output/html/bootstrap.min.css",
+    "examples/ingenia/output/html/ingenia.html",
+    "examples/ingenia/output/html/prettify.css",
+    "examples/ingenia/output/html/prettify.js",
+    "examples/ingenia/output/html/run_prettify.js",
+    "lib/doc_smoosher.rb",
+    "lib/doc_smoosher/api.rb",
+    "lib/doc_smoosher/api_object.rb",
+    "lib/doc_smoosher/example.rb",
+    "lib/doc_smoosher/field.rb",
+    "lib/doc_smoosher/parameter.rb",
+    "lib/doc_smoosher/parameters.rb",
+    "lib/doc_smoosher/request.rb",
+    "lib/doc_smoosher/resource.rb",
+    "lib/doc_smoosher/response.rb",
+    "lib/load_doc_smoosher.rb",
+    "spec/lib/api_spec.rb",
+    "spec/lib/doc_smoosher_spec.rb",
+    "spec/spec_helper.rb",
+    "templates/Readme.md",
+    "templates/api.tt",
+    "templates/html/api.html.erb",
+    "templates/html/bootstrap.min.css",
+    "templates/html/prettify.css",
+    "templates/html/prettify.js",
+    "templates/html/run_prettify.js",
+    "templates/parameter.tt",
+    "templates/request.tt",
+    "templates/resource.tt",
+    "test/test.rb"
+  ]
+  s.homepage = "http://github.com/dangerousbeans/doc_smoosher"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "A simple API documentation generator for the complicated world we live in"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, ["~> 0"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 0"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier>, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<doc_smoosher>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, ["~> 0"])
+      s.add_dependency(%q<rest-client>, ["~> 0"])
+      s.add_dependency(%q<thor>, ["~> 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<terminal-notifier>, [">= 0"])
+      s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<doc_smoosher>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["~> 0"])
+    s.add_dependency(%q<rest-client>, ["~> 0"])
+    s.add_dependency(%q<thor>, ["~> 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<terminal-notifier>, [">= 0"])
+    s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<doc_smoosher>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/examples/ingenia/ingenia.rb

@@ -0,0 +1,387 @@
+$LOAD_PATH << '.'
+require 'bundler/setup'
+require 'doc_smoosher'
+
+extend DocSmoosher::TopLevel
+
+# Shared fields
+limit = define_parameter( name: 'limit' ) do |p|
+  p.description = 'How many results to return'
+  p.type = :integer
+  p.default = 50
+end
+
+offset = define_parameter( name: 'offset' ) do |p|
+  p.description = 'Offset returned results by this amount'
+  p.type = :integer
+  p.default = 0
+end
+
+api_key = define_parameter( name: 'api_key' ) do |p|
+  p.description = 'Your API key'
+  p.type = :string
+  p.required = true
+  p.example = "hg7JHG6daSgf56FjhgsSa"
+end
+
+full_text = define_parameter( name: 'full_text' ) do |p|
+  p.description = 'Should the results be shown with all their text'
+  p.type = :boolean
+  p.default = false
+end
+
+# Item JSON POST form
+json_item_post = define_object( name: 'item' ) do |item|
+  item.description = "A text item"
+  item.parameter name: 'text' do |p|
+    p.description = 'Your item\'s content'
+    p.type = :string
+    p.max = 50_000
+  end
+
+  item.parameter name: 'id' do |p|
+    p.description = 'Custom text/numeric id. This can be used for mapping items back to your own dataset without needing to store the item\'s generated id from ingenia.'
+    p.type = :string
+    p.example = '785uU423aC'
+  end
+
+  item.parameter name: 'tag_ids' do |p|
+    p.description = "The tags you want to have associated with this text item."
+    p.type = :array
+    p.example = '[ "politics", "education", "r&d" ]'
+  end
+
+  item.parameter name: 'tag_sets' do |p|
+    p.description = "Groups of tags that you consider of the same type; tags will come as belonging of a tag set"
+    p.type = :hash
+    p.example = '{ "category": [ "politics", "education", "r&d" ], "geography": [ "united kingdom" ] }'
+  end
+
+  item.example = '{"created_at":"2013-12-16T11:24:52+00:00","id":"e19e134d0e79153349ff78a674283e0b","last_classified_at":null,"text":"What type of cheese is the best cheese?","updated_at":"2013-12-16T11:24:56+00:00","tag_sets":[{"Cookery":{"id":107,"tags":["cheese"]}}}]}'
+end
+
+# Item JSON get form
+json_item_show = define_object( name: 'item' ) do |item|
+  item.description = "A text item"
+  item.parameter name: 'text' do |p|
+    p.description = 'Your item\'s content'
+    p.type = :string
+    p.max = 50_000
+  end
+
+  item.parameter name: 'created_at' do |p|
+    p.description = 'When this item was created'
+    p.type = :date_time
+    p.example = '2013-12-16T11:24:52+00:00'
+  end
+  item.parameter name: 'updated_at' do |p|
+    p.description = 'When this item was last updated'
+    p.type = :date_time
+    p.example = '2013-12-16T11:24:52+00:00'
+  end
+  item.parameter name: 'last_classified_at' do |p|
+    p.description = 'When this item was last classified by the system, or null if it has yet to be classified.'
+    p.type = :date_time
+    p.example = 'null'
+  end
+
+  item.parameter name: 'id' do |p|
+    p.description = 'Custom text/numeric id. This can be used for mapping items back to your own dataset without needing to store the item\'s generated id from ingenia.'
+    p.type = :string
+    p.example = '785uU423aC'
+  end
+
+  item.example = '{"created_at":"2013-12-16T11:24:52+00:00","id":"e19e134d0e79153349ff78a674283e0b","last_classified_at":null,"text":"What type of cheese is the best cheese?","updated_at":"2013-12-16T11:24:56+00:00","tag_sets":[{"Cookery":{"id":107,"tags":["cheese"]}}}]}'
+end
+
+# Tag JSON POST form
+json_tag = define_object( name: 'tag' ) do |tag|
+  tag.description = "A JSON tag"
+  tag.parameter name: 'name' do |p|
+    p.description = 'The name of your tag'
+    p.type = :string
+  end
+
+  tag.parameter name: 'tag_set_id' do |p|
+    p.description = 'The ID of the tag_set that this tag belongs to.'
+    p.type = :integer
+    p.example = '3'
+    p.required = true
+  end
+
+  tag.parameter name: 'description' do |p|
+    p.description = "Textual description of this tag."
+    p.type = :string
+  end
+
+  tag.parameter name: 'disposition' do |p|
+    p.description = "The disposition of the tag. Float value between 0 and 1, defaults to 0.5. Lower values will tend to privilege precision (we suggest 0.25); higher values will tend to privilege recall (we suggest 0.75). For most uses, the default value will work well.
+
+You will want to privilege precision (with a disposition < 0.5) if you want each tag assignment to be accurate, and are less worried about some items being missed, i.e., you prefer to have false negatives than false positives. If the disposition is 0, no item will be tagged with this tag.
+
+You will want to privilege recall (with a disposition > 0.5) if you want each tag assignment to occur, and are less worried about some items being tagged incorrectly, i.e., you prefer to have false positives than false negatives. If the disposition is 1, all items will be tagged with this tag."
+    p.type = :float
+    p.example = 0.7
+    p.default = 0.5
+  end
+end
+
+# TagSet JSON POST form
+json_tag_set = define_object( name: 'tag_set' ) do |tag_set|
+  tag_set.description = "A tag set"
+  tag_set.parameter name: 'name' do |p|
+    p.description = 'The name of your tag set'
+    p.type = :string
+  end
+end
+
+
+# item_json = define_parameter( name: 'json' ) do |p|
+#   p.description = 'JSON encoded string containing a hash of fields for the text item.'
+#   p.type = :json
+#   p.required = false
+#   p.parameter(json_item)
+# end
+
+
+define_api( name: 'Ingenia API' ) do |api|
+  api.description = 'Ingenia analyses your textual content and automatically categorises it using your tags.'
+  api.endpoint = 'api.ingeniapi.com/v2/'
+  api.version = '2.0'
+  api.format = 'json'
+
+  api.object(json_item)
+  api.object(json_tag)
+  api.object(json_tag_set)
+
+  ##
+  # Items
+  #
+  api.resource name: 'items' do |r|
+    r.description = "Nuggets of textual content: somewhat self-contained and homogeneous."
+    
+    r.request name: 'index' do |req|
+      req.description = 'An index of all your items'
+      req.call_type = :get
+      req.path = '/items'
+
+      req.parameter api_key
+      req.parameter limit
+      req.parameter full_text
+      req.parameter offset
+    end
+
+    r.request name: 'show' do |req|
+      req.description = 'View a single item'
+      req.call_type = :get
+      req.path = '/items/:id'
+
+      req.parameter api_key
+      req.parameter full_text
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the item you want to show.'
+        p.type = :string
+        p.example = '3casjghd67'
+        p.required = true
+      end
+    end
+
+    r.request name: 'create' do |req|
+      req.description = 'Create a new item'
+      req.call_type = :post
+      req.path = '/items'
+
+      req.parameter name: 'file' do |p|
+        p.description = 'File to be used as text source. Sent as multipart upload. Accepted file extensions are; Text (txt), Postscript Document Format (pdf) and Microsoft Office Documents (doc, docx, xlsx, ppt, pptx).'
+        p.type = :multipart
+      end
+
+      req.parameter name: 'update_existing' do |p|
+        p.description = 'If the same text is sent, should the existing item be updated on Ingenia? If true then any tags supplied will overwrite those set on the existing item (default). If false, no data is changed and a response is returned with a 409 code (Conflict) together with the existing item as JSON.'
+        p.default = true
+      end
+
+      req.parameter name: 'classify' do |p|
+        p.description = 'Should the response also include a classification.'
+        p.default = false
+      end
+
+      req.parameter api_key
+      req.parameter json_item
+    end
+
+    r.request name: 'update' do |req|
+      req.description = 'Update an existing item'
+      req.call_type = :put
+      req.path = '/items/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the item you want to update.'
+        p.type = :string
+        p.example = '3casjghd67'
+        p.required = true
+      end
+      req.parameter api_key
+      req.parameter json_item
+      req.parameter name: 'file' do |p|
+        p.description = 'File to be used as text source. Sent as multipart upload. Accepted file extensions are; Text (txt), Postscript Document Format (pdf) and Microsoft Office Documents (doc, docx, xlsx, ppt, pptx).'
+        p.type = :multipart
+      end
+    end
+
+    r.request name: 'delete' do |req|
+      req.description = 'Delete an existing item'
+      req.call_type = :delete
+      req.path = '/items/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the item you want to delete.'
+        p.type = :string
+        p.example = '3casjghd67'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+  end
+
+  ##
+  # Tags
+  #
+  api.resource name: 'tags' do |r|
+    r.description = "Tags are meaningful words or expressions that you want to associate to some or all your content items."
+    
+    r.request name: 'index' do |req|
+      req.description = 'An index of all your tags'
+      req.call_type = :get
+      req.path = '/tags'
+
+      req.parameter api_key
+      req.parameter limit
+      req.parameter offset
+    end
+
+    r.request name: 'show' do |req|
+      req.description = 'View a single tag'
+      req.call_type = :get
+      req.path = '/tags/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the tag you want to show.'
+        p.type = :integer
+        p.example = '42'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+
+    r.request name: 'create' do |req|
+      req.description = 'Create a new tag'
+      req.call_type = :post
+      req.path = '/tags'
+
+      req.parameter api_key
+      req.parameter json_tag
+    end
+
+    r.request name: 'update' do |req|
+      req.description = 'Update an existing tag'
+      req.call_type = :put
+      req.path = '/tags/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the tag you want to update.'
+        p.type = :integer
+        p.example = '42'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+
+    r.request name: 'delete' do |req|
+      req.description = 'Delete an existing tag'
+      req.call_type = :delete
+      req.path = '/tags/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the tag you want to delete.'
+        p.type = :integer
+        p.example = '42'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+  end
+
+  ##
+  # Tag Sets
+  #
+  api.resource name: 'tag_sets' do |r|
+    r.description = "Tag sets are thematically consistent groups of tags, such as, say, world countries, business sectors, product types, companies, concepts, topics, etc."
+    
+    r.request name: 'index' do |req|
+      req.description = 'An index of all your Tag Sets'
+      req.call_type = :get
+      req.path = '/tag_sets'
+
+      req.parameter api_key
+      req.parameter limit
+      req.parameter offset
+    end
+
+    r.request name: 'show' do |req|
+      req.description = 'View a single Tag Set'
+      req.call_type = :get
+      req.path = '/tag_sets/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the Tag Set you want to show.'
+        p.type = :integer
+        p.example = '412'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+
+    r.request name: 'create' do |req|
+      req.description = 'Create a new Tag Set'
+      req.call_type = :post
+      req.path = '/tag_sets'
+
+      req.parameter api_key
+      req.parameter json_tag_set
+    end
+
+    r.request name: 'update' do |req|
+      req.description = 'Update an existing Tag Set'
+      req.call_type = :put
+      req.path = '/tag_sets/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the Tag Set you want to update.'
+        p.type = :integer
+        p.example = '412'
+        p.required = true
+      end
+      req.parameter api_key
+      req.parameter json_tag_set
+    end
+
+    r.request name: 'delete' do |req|
+      req.description = 'Delete an existing Tag Set'
+      req.call_type = :delete
+      req.path = '/tag_sets/:id'
+
+      req.parameter name: 'id' do |p|
+        p.description = 'The ID of the Tag Set you want to delete.'
+        p.type = :integer
+        p.example = '412'
+        p.required = true
+      end
+      req.parameter api_key
+    end
+  end
+end
+
+@api = api
+
+api.to_json