a_series_of_tubes 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce7c7a7069aa5bbf7af4714d78016c27b41003e8
-  data.tar.gz: 10e57327f16e1d948823b9f2564c2daf383788f3
+  metadata.gz: 1dc91bfe720e392510cb64ea9ff4c83d7eaadf4c
+  data.tar.gz: 46d79a43419784a9ac5bddf15cdb44aee3c50421
 SHA512:
-  metadata.gz: a12c1280c2cca7faf14292b4a26f8007cb94ebde3319b0e5f525728fcec2c7b96bb6f59ac34ccaa377430b531b5d8fc3b6dd719fc333899ffb669f8ad0bfc414
-  data.tar.gz: c9dc408b96ae0ecce17bccd717ea887f5e14abc82c8b675a577892efb94d6acfe3e128f8ca7c09099cf31af1e7d1a172d20a2fa92aedf591c6f9a5fb7e4cf2b6
+  metadata.gz: 1be9b67e8dc3639c7c029cd4f463e436fdc46957b7b887599e043d1f5781178a7adc5e83257b9096141d4bb331dd3075c8fc921da5b5fa59109c8446544a912e
+  data.tar.gz: d285cee2e1f6ebb30431b41f6a3c89193b6cec47c607d336d49003fd2c3933a3aabc4fe5a21654a77afa01e63f9240829d75017c0d37232f1c3ee026d0caad32

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    a_series_of_tubes (1.0.0)
+    a_series_of_tubes (1.0.1)
       json
       rack
 

data/README.md

@@ -1,7 +1,9 @@
-# ASeriesOfTubes
+# A Series Of Tubes
 
 This is a simple web development framework built in Ruby! It is currently under development, so stay tuned for more updates!
 
+[Sample Server](http://www.github.com/danmakenoise/a_series_of_tubes_demo) | [Live Link](http://aseriesoftubes-demo.herokuapp.com)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,17 +22,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+**A Series of Tubes** is a toolset for creating simple RESTful websites in Ruby. If you are interested in learning how to use it in your project, check out the [Sample Server](http://www.github.com/danmakenoise/a_series_of_tubes_demo) for a suggested application structure.
+
+There are four main components to **A Series of Tubes**:
+
+### Tubes
+
+Tubes are the individual routes users can navigate on your server. You can create a `Tube` via the `Tuber` class. An example set-up is as follows:
+
+```ruby
+tuber = ASeriesOfTubes::Tubes::Tuber.new
+
+tuber.draw do
+  get  Regexp.new('^/$'),         CatsController, :index
+  get  Regexp.new('^/cats$'),     CatsController, :index
+  get  Regexp.new('^/cats/new$'), CatsController, :new
+  post Regexp.new('^/cats$'),     CatsController, :create
+end
+```
+
+The `Tuber` itself is mainly useful as a means for creating the various instances of `Tube` using its `draw` function. Within `draw` you create a `Tube` with the following syntax:
+
+```ruby
+  METHOD REGEX_FOR_PATH, TUBE_CONTROLLER_NAME, TUBE_CONTROLLER_ACTIONS
+
+  # METHOD can be get, post, put, or delete
+```
+
+### TubeController
+
+The `TubeController` is the class that will actually render your HTML/ERB views. For example, in our sample server, the `CatsController#index` action looks like this:
+
+```ruby
+class CatsController < ASeriesOfTubes::TubeController
+  def index
+    @cats = get_cats_from_cookies
+  end
+
+  def get_cats_from_cookies
+    session['cats'] ? session['cats'] : []
+  end
+end
+```
+
+When a `Tube` gets matched to the `index` action, an instance variable `@cats` is created and is populated with any data in the session cookie under the key `cats`. This is another important feature of the `TubeController`! You can user `session[KEY]` to store data to the session cookies of the site. Similarly, there is `flash[KEY]` and `flash.now[KEY]`, which can be used to only store information for the next render or redirect.
+
+### TubeSupport
 
-## Development
+This module just contains helper functions for the entire gem.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### TubeState
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This module contains the internal workings of the `session` and `flash` abilities of the `TubeController` class.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rake-db-migrate/a_series_of_tubes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/danmakenoise/a_series_of_tubes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/a_series_of_tubes.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dan@danphillips.io"]
 
   spec.summary       = "a web development framework"
-  spec.homepage      = "http://www.github.com/rake-db-migrate/a_series_of_tubes"
+  spec.homepage      = "http://www.github.com/danmakenoise/a_series_of_tubes"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/a_series_of_tubes/version.rb

@@ -1,3 +1,3 @@
 module ASeriesOfTubes
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a_series_of_tubes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dan Phillips
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,8 @@ files:
 - lib/a_series_of_tubes/tubes/tube.rb
 - lib/a_series_of_tubes/tubes/tuber.rb
 - lib/a_series_of_tubes/version.rb
-homepage: http://www.github.com/rake-db-migrate/a_series_of_tubes
+- pkg/a_series_of_tubes-1.0.0.gem
+homepage: http://www.github.com/danmakenoise/a_series_of_tubes
 licenses:
 - MIT
 metadata: {}