protolink 0.1.0

data/README.markdown

@@ -0,0 +1,150 @@
+# ProtoLink - Access your ProtoNet
+
+ProtoLink is a library for interfacing with ProtoNet, the next-gen internet infrastructure. Truly social and people-powered.
+
+Version: 0.1.0
+
+Sorry, there are no tests at all yet...
+
+
+## Dependencies
+
+    activesupport
+    faraday -v 0.5.1
+    multipart-post
+    mime-types
+    twitter-stream (for streaming listening in future)
+    eventmachine
+
+
+## Usage
+
+    # CHANNELS
+
+    # simple message
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    channel  = protonet.channels.first
+    channel.speak 'Hello world!'
+
+
+    # post message in specific channel
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    channel  = protonet.find_channel_by_name("test")
+    channel.speak 'Hello world!'
+
+
+    # create a channel
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    channel  = protonet.create_channel("test", "This is the description... woah")
+    channel.speak 'Hello world!'
+
+
+    # find or create a channel
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    channel  = protonet.find_or_create_channel_by_name("test", "This is the description... woah")
+    channel.speak 'Hello world!'
+
+
+    # USERS
+
+    # find user by login
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user     = protonet.find_user_by_login("bjoern.dorra")
+
+
+    # create a user
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user     = protonet.create_user("testuser", "mymassword", "Test-User", "test@test.de")
+
+
+    # find or create a user
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user     = protonet.find_or_create_user_by_login("testuser", "mymassword", "Test-User", "test@test.de")
+
+
+    # get users auth_token for auto-login
+    require 'rubygems'
+    require 'protolink'
+
+    protonet = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user     = protonet.find_user_by_name("bjoern.dorra")
+    user.auth_token
+      => "A19zNgCzgv4RGDGPc2mL" 
+
+
+    # LISTENS
+
+    # create a listen
+    require 'rubygems'
+    require 'protolink'
+
+    protonet   = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user       = protonet.find_user_by_login("bjoern.dorra")
+    channel    = protonet.find_channel_by_name("test")
+    protonet.create_listen(user.id, channel.id)
+
+    # destroy a listen
+    require 'rubygems'
+    require 'protolink'
+
+    protonet   = Protolink::Protonet.new('SUBDOMAIN.DOMAIN.DE', 'USERLOGIN', 'PASSWORD', :ssl => false)
+    user       = protonet.find_user_by_login("bjoern.dorra")
+    channel    = protonet.find_channel_by_name("test")
+    protonet.destroy_listen(user.id, channel.id)
+
+
+    # CREATE AND SUBSCRIBE
+
+    require 'rubygems'
+    require 'protolink'
+
+    protonet   = Protolink::Protonet.new('localhost:3000', 'bjoern.dorra', 'geheim')
+
+    user       = protonet.find_or_create_user_by_login("johndoe", "password", "JohnDoe", "john@doe.com")
+    auth_token = user.auth_token
+    channel    = protonet.find_or_create_channel_by_name("test", "This is a test channel!")
+    protonet.create_listen(user.id, channel.id)
+    "\nhttp://localhost:3000/?auth_token=#{auth_token}"
+
+
+## Installation
+
+    gem install protolink
+
+
+## How to contribute
+
+If you find what looks like a bug:
+
+1. Check the GitHub issue tracker to see if anyone else has had the same issue.
+   http://github.com/protonet/protolink/issues/
+2. If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+1. Fork the project on github.
+   http://github.com/protonet/protolink
+2. Make your changes with tests.
+3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
+4. Send a pull request.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# require 'rspec/core/rake_task'
+# desc 'Run the specs'
+# RSpec::Core::RakeTask.new do |r|
+#   r.verbose = false
+# end
+
+# task :default => :spec

data/example/create_and_subscribe.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'protolink'
+
+protonet   = Protolink::Protonet.new('localhost:3000', 'bjoern.dorra', 'geheim')
+
+user       = protonet.find_or_create_user_by_login("johndoe", "password", "John Doe", "john@doe.com")
+auth_token = user.auth_token
+puts       "user_id     : #{user.id}"
+puts       "user_login  : #{user.login}"
+puts       "auth_token  : #{auth_token}"
+
+channel    = protonet.find_or_create_channel_by_name("test", "This is a test channel!")
+puts       "channel_id  : #{channel.id}"
+puts       "channel_name: #{channel.name}"
+puts       "channel_desc: #{channel.description}"
+
+protonet.create_listen(user.id, channel.id)
+
+puts       "\nhttp://localhost:3000/?auth_token=#{auth_token}"

data/lib/protolink.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+require 'active_support/json'
+require 'mime/types'
+
+require 'protolink/connection'
+require 'protolink/protonet'
+require 'protolink/channel'
+require 'protolink/user'
+require 'protolink/listen'
+require 'protolink/middleware'
+
+module Protolink
+  class Error < StandardError; end
+  class SSLRequiredError < Error; end
+  class AuthenticationFailed < Error; end
+  class ListenFailed < Error; end
+end

data/lib/protolink/channel.rb

@@ -0,0 +1,45 @@
+module Protolink
+  class Channel
+    attr_reader :id, :name, :description
+
+    def initialize(connection, attributes = {})
+      @connection  = connection
+      @id          = attributes['id']
+      @name        = attributes['name']
+      @description = attributes['description']
+      @loaded      = false
+    end
+    
+
+    # Post a new message to the chat channel
+    def speak(message, options = {})
+      send_message(message)
+    end
+
+
+    protected
+
+      def load
+        reload! unless @loaded
+      end
+
+      # does not work yet
+      def reload!
+        attributes = connection.get("/api/v1/channels/#{@id}.json")['channel']
+
+        @id          = attributes['id']
+        @name        = attributes['name']
+        @description = attributes['description']
+        @loaded      = true
+      end
+
+      def send_message(message)
+        connection.post("/api/v1/meeps/create", {:channel_id => self.id, :message => message})
+      end
+
+      def connection
+        @connection
+      end
+
+  end
+end

data/lib/protolink/connection.rb

@@ -0,0 +1,83 @@
+require 'uri'
+require 'faraday'
+
+module Protolink
+  class Connection
+
+    attr_reader :domain, :username, :password, :uri, :options
+
+    def self.connection
+      @connection ||= Faraday::Connection.new do |conn|
+        conn.use      Faraday::Request::ActiveSupportJson
+        conn.adapter  :net_http
+        conn.use      Protolink::FaradayResponse::RaiseOnAuthenticationFailure
+        conn.use      Faraday::Response::ActiveSupportJson
+        conn.use      Protolink::FaradayResponse::WithIndifferentAccess
+
+        conn.headers['Content-Type'] = 'application/json'
+      end
+    end
+
+    def self.raw_connection
+      @raw_connection ||= Faraday::Connection.new do |conn|
+        conn.adapter  Faraday.default_adapter
+        conn.use      Protolink::FaradayResponse::RaiseOnAuthenticationFailure
+        conn.use      Faraday::Response::ActiveSupportJson
+        conn.use      Protolink::FaradayResponse::WithIndifferentAccess
+      end
+    end
+
+    def initialize(domainname, username, password, options = {})
+      @domainname   = domainname
+      @username = username
+      @password = password
+      @options  = { :ssl => false, :proxy => ENV['HTTP_PROXY'] }.merge(options)
+      @uri = URI.parse("#{@options[:ssl] ? 'https' : 'http' }://#{domainname}")
+
+      connection.basic_auth username, password
+      raw_connection.basic_auth username, password
+    end
+
+    def connection
+      @connection ||= begin
+        conn = self.class.connection.dup
+        conn.url_prefix = @uri.to_s
+        conn.proxy options[:proxy]
+        conn
+      end
+    end
+
+    def raw_connection
+      @raw_connection ||= begin
+        conn = self.class.raw_connection.dup
+        conn.url_prefix = @uri.to_s
+        conn.proxy options[:proxy]
+        conn
+      end
+    end
+
+    def get(url, *args)
+      response = connection.get(url, *args)
+      response.body
+    end
+
+    def post(url, body = nil, *args)
+      response = connection.post(url, body, *args)
+      response.body
+    end
+
+    def raw_post(url, body = nil, *args)
+      response = raw_connection.post(url, body, *args)
+    end
+
+    def put(url, body = nil, *args)
+      response = connection.put(url, body, *args)
+      response.body
+    end
+
+    # Is the connection using ssl?
+    def ssl?
+      uri.scheme == 'https'
+    end
+  end
+end

data/lib/protolink/listen.rb

@@ -0,0 +1,35 @@
+module Protolink
+  class Listen
+    attr_reader :id, :user_id, :channel_id
+
+    def initialize(connection, attributes = {})
+      @connection = connection
+      @id         = attributes['id']
+      @user_id    = attributes['user_id']
+      @channel_id = attributes['channel_id']
+      @loaded     = false
+    end
+
+
+    protected
+
+      def load
+        reload! unless @loaded
+      end
+
+      # does not work yet
+      def reload!
+        attributes  = connection.get("/api/v1/listens/#{@id}.json")['listen']
+
+        @id         = attributes['id']
+        @user_id    = attributes['user_id']
+        @channel_id = attributes['channel_id']
+        @loaded     = true
+      end
+
+      def connection
+        @connection
+      end
+
+  end
+end

data/lib/protolink/middleware.rb

@@ -0,0 +1,30 @@
+module Protolink
+  module FaradayResponse
+    class WithIndifferentAccess < ::Faraday::Response::Middleware
+      begin
+        require 'active_support/core_ext/hash/indifferent_access'
+      rescue LoadError, NameError => error
+        self.load_error = error
+      end
+
+      def self.register_on_complete(env)
+        env[:response].on_complete do |response|
+          json = response[:body]
+          if json.is_a?(Hash)
+            response[:body] = ::HashWithIndifferentAccess.new(json)
+          elsif json.is_a?(Array) and json.first.is_a?(Hash)
+            response[:body] = json.map{|item| ::HashWithIndifferentAccess.new(item) }
+          end
+        end
+      end
+    end
+
+    class RaiseOnAuthenticationFailure < ::Faraday::Response::Middleware
+      def self.register_on_complete(env)
+        env[:response].on_complete do |response|
+          raise AuthenticationFailed if response[:status] == 401
+        end
+      end
+    end
+  end
+end

data/lib/protolink/protonet.rb

@@ -0,0 +1,86 @@
+module Protolink
+
+  #   protonet = Protolink::Protonet.new 'domain', :user => 'john.doe', :password => 'secret', :token => 'xyz'
+  #
+  #   channel = protonet.find_channel_by_name 'home'
+  #   channel.speak 'Hello world!'
+  class Protonet
+    attr_reader :connection
+
+    # Create a new connection to the account with the given +domain+.
+    #
+    # == Options:
+    # * +:ssl+: use SSL for the connection, which is required if you have a Protonet SSL account.
+    #           Defaults to false
+    # * +:proxy+: a proxy URI. (e.g. :proxy => 'http://user:pass@example.com:8000')
+    #
+    def initialize(domainname, username, password, options = {})
+      @connection = Connection.new(domainname, username, password, options)
+    end
+
+
+    # CHANNELS
+
+    # Get an array of all the available channels
+    def channels
+      s = connection.get('/api/v1/channels.json')
+      s = Hash["channels", s]
+      s['channels'].map do |channel|
+        Channel.new(connection, channel)
+      end
+    end
+
+    # Find a Channel by name
+    def find_channel_by_name(name)
+      channels.detect { |channel| channel.name == name }
+    end
+
+    # Creates and returns a new Channel with the given +name+ and optionally a +description+
+    def create_channel(name, description = nil)
+      connection.post('/api/v1/channels/create.json', {  :name => name, :description => description } )
+      find_channel_by_name(name)
+    end
+
+    def find_or_create_channel_by_name(name, description = nil)
+      find_channel_by_name(name) || create_channel(name, description)
+    end
+
+
+    # USERS
+    
+    # Get an array of all the available users
+    def users
+      s = connection.get('/api/v1/users.json')
+      s = Hash["users", s]
+      s['users'].map do |user|
+        User.new(connection, user)
+      end
+    end
+
+    # Creates and returns a new user with the given attributes
+    def create_user(login, password, name, email, avatar_url = nil, channels = nil)
+      connection.post('/api/v1/users/create.json', {:login => login, :name => name, :password => password, :email => email, :avatar_url => avatar_url, :channels => channels } )
+      find_user_by_login(login)
+    end
+
+    # Find a user by name
+    def find_user_by_login(login)
+      users.detect { |user| user.login == login }
+    end
+
+    def find_or_create_user_by_login(login, password, name, email, avatar_url = nil, channels = nil)
+      find_user_by_login(name) || create_user(login, password, name, email, avatar_url = nil, channels = nil)
+    end
+
+
+    # LISTENS
+    def create_listen(user_id, channel_id)
+      connection.post('/api/v1/listens/create.json', {:user_id => user_id, :channel_id => channel_id } )
+    end
+
+    def destroy_listen(user_id, channel_id)
+      connection.post('/api/v1/listens/destroy.json', {:user_id => user_id, :channel_id => channel_id } )
+    end
+
+  end
+end

data/lib/protolink/user.rb

@@ -0,0 +1,47 @@
+module Protolink
+  class User
+    attr_reader :id, :name, :login, :email, :avatar_url
+
+    def initialize(connection, attributes = {})
+      @connection = connection
+      @id         = attributes['id']
+      @name       = attributes['name']
+      @login      = attributes['login']
+      @email      = attributes['email']
+      @avatar_url = attributes['avatar_url']
+      @loaded     = false
+    end
+
+    # get token for autologin
+    def auth_token
+      receive_auth_token
+    end
+
+    protected
+
+      def receive_auth_token
+        connection.get("/api/v1/users/auth_token.json?user_id=#{self.id}")['token']
+      end
+
+      def load
+        reload! unless @loaded
+      end
+
+      # does not work yet
+      def reload!
+        attributes = connection.get("/api/v1/users/#{@id}.json")['user']
+
+        @id         = attributes['id']
+        @name       = attributes['name']
+        @login      = attributes['login']
+        @email      = attributes['email']
+        @avatar_url = attributes['avatar_url']
+        @loaded    = true
+      end
+
+      def connection
+        @connection
+      end
+
+  end
+end

data/lib/protolink/version.rb

@@ -0,0 +1,3 @@
+module Protolink
+  VERSION = '0.1.0' unless defined?(::Protolink::VERSION)
+end

data/protolink.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "protolink/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{protolink}
+  s.version = Protolink::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Björn B. Dorra"]
+  s.description = %q{A Ruby API for interfacing with Protonet, the next-gen internet infrastructure. Truly social and people-powered.}
+  s.email = %q{dorra@d-1.comg}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.homepage = %q{http://github.com/protonet/protolink}
+  s.rubyforge_project = %q{protolink}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby wrapper for the ProtoNet API}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday>, ["~> 0.5.1"])
+      s.add_runtime_dependency(%q<multipart-post>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_runtime_dependency(%q<twitter-stream>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<faraday>, ["~> 0.5.1"])
+      s.add_dependency(%q<multipart-post>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<twitter-stream>, [">= 0"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<faraday>, ["~> 0.5.1"])
+    s.add_dependency(%q<multipart-post>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<twitter-stream>, [">= 0"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: protolink
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Bj\xC3\xB6rn B. Dorra"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: twitter-stream
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: A Ruby API for interfacing with Protonet, the next-gen internet infrastructure. Truly social and people-powered.
+email: dorra@d-1.comg
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- example/create_and_subscribe.rb
+- lib/protolink.rb
+- lib/protolink/channel.rb
+- lib/protolink/connection.rb
+- lib/protolink/listen.rb
+- lib/protolink/middleware.rb
+- lib/protolink/protonet.rb
+- lib/protolink/user.rb
+- lib/protolink/version.rb
+- protolink.gemspec
+has_rdoc: true
+homepage: http://github.com/protonet/protolink
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: protolink
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the ProtoNet API
+test_files: []
+