twin 0.1.1 → 0.1.2

data/README.md

@@ -0,0 +1,77 @@
+Twitter's Twin
+==============
+
+<i>Twin</i> is a Rack middleware which provides your app with a subset of Twitter's API. In other words, it makes your app respond to certain requests as if it were "api.twitter.com".
+
+This is useful in combination with Twitter clients which allow you to change the hostname used for API requests. If your Twitter client allows you to configure it to fetch updates from "yourapp.net" instead of "api.twitter.com", you could serve fake "tweets" from your app and use the Twitter client to read them.
+
+**Twitter for iPhone** is a free client that allows you to customize the hostname. (Its version for iPad does not, for some reason.) Known desktop clients that support the same are [Twitterrific][] and [Spaz][].
+
+Two popular websites which already implement the Twitter API are [WordPress.com][wp] and [Tumblr][]. Twin is a library for Ruby apps to do the same.
+
+
+Installation
+------------
+
+For Ruby on Rails, add "twin" to your Gemfile. For other apps, a little bit more is needed:
+
+    ## Gemfile for non-Rails apps
+    gem 'twin'
+    gem 'i18n'    # not really used; needed to load some part of Active Support
+    gem 'builder' # used for constructing XML responses
+
+Twin's dependency is Active Support, from which only few bits are loaded.
+
+Now, mount "Twin" as middleware:
+
+    ## Ruby on Rails
+    config.middleware.use Twin
+    
+    ## Sinatra
+    use Twin
+
+
+Data models
+-----------
+
+Twin uses a model named by default "TwinAdapter" to fetch records from your app. You have to write this model yourself and implement several methods to define which data sent back to the client.
+
+The template for TwinAdapter is available in ["example/twin_adapter.rb"][adapter].
+
+The adapter should return two types of records: one representing twitter "statuses" and the other representing users. Both types of records should either be hashes containing twitter-compatible keys or they should implement the `to_twin_hash` method that returns such values.
+
+Examples for implementing `to_twin_hash` for typical Active Record models is in ["example/to_twin_hash.rb"][hash].
+
+
+Configuring Twitter for iPhone
+------------------------------
+
+With Twin middleware and data models in place, your app is ready to receive requests from Twitter clients. To try this out with Twitter for iPhone, go to the "Accounts" page and start creating a new account. Before submitting the username and password, tap the cogwheel to access the advanced configuration screen. Type in your hostname for "API root", return back and finish the process.
+
+![Advanced configuration screen displaying "http://example.com"](http://img.skitch.com/20101129-fab66pj66hcqwu5wbwf3ci3y8f.png)
+
+Using Twitter for iPhone in this manner may not be without bugs. This client caches user info based on screen name, *regardless* of the host where they come from. If a user from your Twin-enabled app shares the same screen name as an existing Twitter user, their info (and avatar pictures) might mix.
+
+
+API support
+-----------
+
+Twin doesn't implement the full Twitter API — far from it. It only implements the basic subset required to read the main timeline. Posting is not yet implemented. Replies/mentions, lists, saved searches and direct messages are not functional; their read APIs are implemented but they return empty collections. There is no rate limiting.
+
+To see which APIs are implemented, [check out "twin/resources.rb"][resources].
+
+
+Credits
+-------
+
+Twin was written by Mislav Marohnić for [Teambox](http://teambox.com) and later extracted into a reusable library after a [gentle nudge by Shane Becker][shane].
+
+
+[spaz]: http://getspaz.com/
+[twitterrific]: http://iconfactory.com/software/twitterrific
+[adapter]: https://github.com/mislav/twin/blob/master/example/twin_adapter.rb
+[hash]: https://github.com/mislav/twin/blob/master/example/to_twin_hash.rb
+[resources]: https://github.com/mislav/twin/blob/master/lib/twin/resources.rb
+[wp]: http://en.support.wordpress.com/twitter-api/ "WordPress.com Twitter API"
+[tumblr]: http://staff.tumblr.com/post/287703110/api
+[shane]: http://iamshane.com/notes/2010/11/9/1/twitter-clone-gem "We need a Twitter API clone Ruby Gem"

data/lib/twin.rb

@@ -150,9 +150,10 @@ class Twin
   end
   
   def convert_twin_hash(object)
-    if Hash === object then object
-    elsif object.respond_to? :to_twin_hash
+    if object.respond_to? :to_twin_hash
       object.to_twin_hash
+    elsif Hash === object
+      object
     elsif object.respond_to? :attributes
       object.attributes
     else
@@ -172,7 +173,7 @@ class Twin
   def content_type_from_format(format)
     case format
     when 'xml' then 'application/xml'
-    when 'json' then 'application/x-json'
+    when 'json' then 'application/json'
     end
   end
   
@@ -182,7 +183,7 @@ class Twin
     else
       case self.content_type
       when 'application/xml' then body.to_xml
-      when 'application/x-json' then body.to_json
+      when 'application/json' then body.to_json
       when 'application/x-www-form-urlencoded' then body.to_query
       else
         raise "unrecognized content type: #{self.content_type.inspect} (format: #{self.format})"

data/lib/twin/resources.rb

@@ -73,7 +73,19 @@ class Twin
     respond_with('saved_searches', [])
   end
   
-  resource 'account/(settings|apple_push_destinations(/(destroy|device))?)' do
+  resource 'account/(settings|(apple_)?push_destinations(/(destroy|device))?)' do
+    not_implemented
+  end
+  
+  resource 'trends/(\d+)' do
+    not_implemented
+  end
+  
+  resource 'statuses/friends' do
+    not_implemented
+  end
+  
+  resource 'help/configuration' do
     not_implemented
   end
   

metadata

@@ -1,85 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: twin
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
 platform: ruby
-authors: 
-- "Mislav Marohni\xC4\x87"
+authors:
+- Mislav Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-29 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70155972080040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id001
-description: Rack middleware to expose a Twitter-like API from your app.
+  prerelease: false
+  version_requirements: *70155972080040
+description: Rack middleware to expose a Twitter-like API in your app.
 email: mislav.marohnic@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/twin/resources.rb
 - lib/twin.rb
 - test/app.rb
 - test/config.ru
 - test/tmp/restart.txt
-has_rdoc: false
+- README.md
 homepage: http://github.com/mislav/twin
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Twitter's twin
 test_files: []
-
+has_rdoc: