transistor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b5176c42b0149790524cb131b0fe4e070c775ae
+  data.tar.gz: 1fd188be8e56121b75c75adcda575943d9eaf5dc
+SHA512:
+  metadata.gz: 601eca82ca3e84ae2a95b47949fd14ce6a2dca83fd5cada55792ee2f9df457b08c3ede7fc92d088a1df7ee9f67409f30ab4e71ac900beb5e8025faa78418ffbd
+  data.tar.gz: a97eb35930783a87e68d37fc52dc545310ee06723671acee136837c5d2467e32945ca0be4df2e465b9ac0e7e70ab5124178fea79030e5382966f29af070c801f

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem 'jasmine'
+
+gem 'jslint-v8'
+
+gem 'jake'
+
+gem 'rake'
+
+gem 'gem-this'

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.4)
+    eventful (1.0.1)
+      methodphitamine (= 1.0.0)
+    ffi (1.8.1)
+    gem-this (0.3.7)
+    jake (1.1.1)
+      eventful (>= 1.0.0)
+      oyster (>= 0.9.5)
+      packr (>= 3.2.0)
+    jasmine (1.3.2)
+      jasmine-core (~> 1.3.1)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.3.1)
+    jslint-v8 (1.1.1)
+      therubyracer (~> 0.10.0)
+    libv8 (3.3.10.4)
+    methodphitamine (1.0.0)
+    multi_json (1.7.2)
+    oyster (0.9.5)
+    packr (3.2.1)
+      oyster (>= 0.9.5)
+    rack (1.5.2)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.32.1)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    therubyracer (0.10.2)
+      libv8 (~> 3.3.10)
+    websocket (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gem-this
+  jake
+  jasmine
+  jslint-v8
+  rake

data/README.md

@@ -0,0 +1,96 @@
+# Radiotower Client
+
+The javascript client consists mainly of two parts:
+
+* Transistor.Control
+* Transistor.Radio
+
+## Control
+
+The Control object is used for administrative work on a station. It is initialized as following:
+
+```javascript
+var broadcaster_url = "http://broadcast.radiotower.io",
+    station_uid = "5a665bf153c0437bdb14a3004dad52e1",
+    push_token  = "e29c6c92143cfaa0d5026aebf87f1a0f";
+
+var control = Transistor.Control(broadcaster_url, station_uid, push_token);
+```
+
+The main purpose of the Control object is the administration of specific channels. It supports the following basic collection operations:
+
+```javascript
+control.set("channel/path", [{value: 'collection'}, {value: 'of'}, {value: 'entries'}]);
+control.insert("channel/path", {value: 'object that gets pushed'});
+control.update("channel/path", 12, {value: 'i am the new object w/ id 12'});
+control.remove("channel/path", 23); // object w/ id 23 gets removed
+```
+
+The actual ids of an specific entry are retrieved through the client, which usage gets explained in the following chapter.
+
+## Radio
+
+The Radio object can be used --- as the name might suggest --- for listening to specific channels of a station of the Radiotower. It is initialized as following:
+
+```javascript
+var station_finder_url  = "http://station_finder.radiotower.io",
+    station_uid         = "5a665bf153c0437bdb14a3004dad52e1",
+    test_token          = "d10cf06ecd08ff5bc0df1c8bb84d1107"
+    // or use the live_token, if it's a production application
+
+var radio = Transistor.Radio(station_finder_url, station_uid, test_token);
+```
+
+Now the basic Radio is initialized. No network connections or requests are done so far. On a second step, you have to tune your radio to all the channels, you want to listen to:
+
+```javascript
+var listener = function (event, args) {
+  console.log("Event '"+event+"' occured with args", arg);
+};
+
+radio.tune("news", listener);
+radio.tune("sports", listener);
+```
+
+Even at this point, no connections where made, the listener structure is 100% passive.
+
+To get things startet, you have to turn on the Radio (sounds pretty clear, eh?).
+
+This will fire a request to the StationFinder like: "Hey, here I am, at which frequency can I get my channels, and what is their current state??"
+
+```javascript
+radio.turnOn();
+```
+
+From now on, your listener will fire, whenever an specific event occures. Below is a listing of the possible events and their respective arguments:
+
+```javascript
+// These are the arguments of the called listener (event, args)
+
+// "init",    {collection: [{id: 12, object: {..}}, {id: 13, object: {..}]}
+// "set",     {collection: [{id: 12, object: {..}}, {id: 13, object: {..}]}
+// "insert",  {entry: {id: 24, object: {..}}}
+// "update",  {id: 13, entry: {id: 13, object: {..}}}
+// "remove",  {id: 13}
+```
+
+## Binders
+
+To simplify the binding between a remote Radiotower collection and your local array, Transistor gives you a nifty little tool called Binder.
+
+Mainly, it implements a simple and thin listener which keeps track of changes and updates an array accordingly. Use it this way:
+
+```javascript
+// radio is already initialized but not turned on yet
+
+var news        = [],
+    news_binder = Transistor.Binder(news);
+
+radio.tune("the/news", news_binder);
+
+radio.turnOn();
+```
+
+From now on, your local array `news` is an exact copy of the collection in the channel "the/news". Radio and Binder are there for you, they talk and sync and you have nothing to worry about at all while using your local array.
+
+But keep in mind, that changes on the array itself will bring most likely inconsitencies in your data. All updates, inserts, a.s.o. *MUST* bew made through the Control object.

data/Rakefile

@@ -0,0 +1,109 @@
+require 'rake'
+require 'jslint-v8'
+
+namespace :js do
+  JSLintV8::RakeTask.new do |task|
+    task.name = "lint"
+    task.description = "runs jslint against all important javascript files"
+
+    task.output_stream = STDOUT
+
+    task.include_pattern = "lib/transistor/*.js"
+
+    task.browser = true  # predefine Browser globals
+  end
+end
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+
+require "rubygems"
+require "rubygems/package_task"
+require "rdoc/task"
+
+require "rspec"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
+end
+
+
+task :default => ["spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "transistor"
+  s.version           = "0.1.0"
+  s.summary           = "Client for the radiotower.io service"
+  s.author            = "Jakob Holderbaum"
+  s.email             = "jakob@featurefabrik.de"
+  s.homepage          = "http://featurefabrik.com"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.md)
+  s.rdoc_options      = %w(--main README.md)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(Gemfile.lock index.html Rakefile Gemfile faye-browser.js README.md jake.yml) + Dir.glob("{spec,lib}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency('jasmine')
+  s.add_development_dependency('jslint-v8')
+  s.add_development_dependency('jake')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('gem-this')
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+# Generate documentation
+RDoc::Task.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end