arena 0.0.9 → 0.1.0

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+_debug.rb

data/README.md

@@ -18,9 +18,24 @@ Or install it yourself as:
 
 Register an application at http://dev.are.na
 
-### Configure for personal use
+### Configure for personal use (optional; be aware this grants access to everything your account has access to)
 ```ruby
 Arena.configure do |config|
     config.access_token = 'XXXXXXXXXXXXX'
 end
 ```
+
+### Simple usage example
+
+```ruby
+@channel = Arena.channel(params[:id])
+```
+
+```erb
+<% @channel.contents.each do |connectable| %>
+    <%= connectable.title %>
+    <% if connectable.has_image? %>
+        <img src="<%= connectable.image.display.url %>" alt="<%= connectable.title %>" />
+    <% end %>
+<% end %>
+```

data/lib/arena.rb

@@ -1,7 +1,8 @@
 require "arena/version"
-require_relative "./arena/client"
-require_relative "./arena/default"
-require_relative "./arena/configurable"
+
+load "arena/client.rb"
+load "arena/default.rb"
+load "arena/configurable.rb"
 
 module Arena
   class << self
@@ -10,6 +11,7 @@ module Arena
     # Delegate to a Arena::Client
     #
     # @return [Arena::Client]
+    # 
     def client
       if @client
         @client
@@ -23,8 +25,7 @@ module Arena
     def method_missing(method, *args, &block)
       self.client.send(method, *args, &block)
     end
+  end # self
+end # Arena
 
-  end
-end
-
-Arena.setup
+Arena.setup

data/lib/arena/account.rb

@@ -0,0 +1,26 @@
+require "arena/base"
+require "arena/user"
+
+module Arena
+  class Account < Arena::Base
+    def user
+      @user ||= Arena::User.new(@attrs["user"])
+    end
+
+    def channels
+      @channels ||= @attrs["channels"].collect { |channel| Arena::Channel.new(channel) }
+    end
+
+    def help_channels
+      @help_channels ||= @attrs["help_channels"].collect { |channel| Arena::Channel.new(channel) }
+    end
+
+    def following_channel_ids
+      @following_channel_ids ||= @attrs["following_ids"]["channels"]
+    end
+
+    def following_user_ids
+      @following_user_ids ||= @attrs["following_ids"]["users"]
+    end
+  end
+end

data/lib/arena/api.rb

@@ -1,8 +1,11 @@
-require 'arena/user'
-require 'arena/block'
-require 'arena/channel'
-require 'arena/results'
-require 'arena/search_results'
+require "arena/user"
+require "arena/block"
+require "arena/channel"
+require "arena/results"
+require "arena/search_results"
+require "arena/account"
+require "arena/comment"
+require "arena/feed"
 
 module Arena
   module API
@@ -46,6 +49,11 @@ module Arena
       object_from_response(Arena::Block, :get, "/blocks/#{id}", options)
     end
 
+    # Returns Block comments
+    def block_comments(id, options={})
+      collection_from_response(Arena::Comment, :get, "/blocks/#{id}/comments", "comments", options)
+    end
+
     # Returns a User representation
     def user(id, options={})
       object_from_response(Arena::User, :get, "/users/#{id}", options)
@@ -56,18 +64,47 @@ module Arena
       object_from_response(Arena::ChannelResults, :get, "/users/#{id}/channels", options)
     end
 
+    # Full representation of the account endpoint
+    def account(options={})
+      require_authentication!
+
+      object_from_response(Arena::Account, :get, "/accounts", options)
+    end
+
     # All of the authenticated user's Channels
     def account_channels(options={})
+      require_authentication!
+
       object_from_response(Arena::ChannelResults, :get, "/accounts/channels", options)
     end
 
+    # Returns the authenticated user's settings
+    def settings(options={})
+      require_authentication!
+
+      object_from_response(Arena::User, :get, "/accounts/settings", options)
+    end
+
     # Returns a Search object with an Array for Channels, Blocks and Users
-    def search(query, option={})
-      object_from_response(Arena::SearchResults, :get, "/search?q=#{query}", options)
+    def search(query, options={})
+      path = options[:kind].nil? ? "/search/?q=#{query}" : "/search/#{options[:kind]}/?q=#{query}"
+
+      object_from_response(Arena::SearchResults, :get, path, options)
+    end
+
+    # Returns a Feed object with an arry of Stories
+    def feed(options={})
+      require_authentication!
+
+      object_from_response(Arena::Feed, :get, "/feed", options)
     end
 
   private
 
+    def require_authentication!
+      # todo: Raise error if key missing
+    end
+
     def object_from_response(klass, request_method, url, options={})
       response = send(request_method.to_sym, url, options)
       klass.new(response)
@@ -77,9 +114,8 @@ module Arena
       array.collect { |element| klass.new(element) }
     end
 
-    def collection_from_response(klass, request_method, url, options={}, selector)
+    def collection_from_response(klass, request_method, url, selector, options={})
       collection_from_array(klass, send(request_method.to_sym, url, options)[selector])
     end
-
-  end
-end
+  end # API
+end # Arena

data/lib/arena/block.rb

@@ -1,11 +1,11 @@
 require 'arena/base'
+require 'arena/creatable'
+require 'arena/connectable'
 require 'arena/entity'
 require 'arena/entities/source'
 require 'arena/entities/image'
 require 'arena/entities/attachment'
 require 'arena/entities/embed'
-require 'arena/creatable'
-require 'arena/connectable'
 
 module Arena
   class Block < Arena::Base
@@ -15,10 +15,6 @@ module Arena
     attr_reader :id, :title, :generated_title, :state, :comment_count, :content,
       :content_html, :description, :description_html
 
-    def user
-      @user ||= Arena::User.new(@attrs['user'])
-    end
-
     def _class
       @_class ||= @attrs['class']
     end
@@ -28,7 +24,7 @@ module Arena
     end
 
     def source
-      @source ||= Arena::Entity::Source.new(@attrs['source'])
+      @source ||= Arena::Entity::Source.new(@attrs['source']) if !@attrs['source'].nil?
     end
 
     def image
@@ -42,18 +38,6 @@ module Arena
     def embed
       @embed ||= Arena::Entity::Embed.new(@attrs['embed']) if has_embed?
     end
-
-    def connections
-      @connections ||= @attrs['connections'].collect { |channel| Arena::Channel.new(channel) }
-    end
-
-    # Detect optional portions of the response
-    [:image, :attachment, :embed].each do |kind|
-      define_method "has_#{kind}?" do
-        !@attrs[kind.to_s].nil?
-      end
-    end
-
   end
 
   class Text < Block; end
@@ -61,4 +45,4 @@ module Arena
   class Link < Block; end
   class Media < Block; end
   class Attachment < Block; end
-end
+end

data/lib/arena/cache.rb

@@ -0,0 +1,25 @@
+require "arena/cache/adaptor/rails"
+require "arena/cache/adaptor/padrino"
+require "arena/cache/adaptor/null"
+
+module Arena
+  module Cache
+    class << self
+      def adapt_to
+        if defined?(Rails)
+          "Rails"
+        elsif defined?(Padrino)
+          "Padrino"
+        else
+          "Null"
+        end
+      end
+
+      # Delegate to the appropriate cache engine
+      # 
+      def method_missing(method, *args, &block)
+        "Arena::Cache::Adaptor::#{adapt_to}".constantize.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/arena/cache/adaptor/generic.rb

@@ -0,0 +1,11 @@
+require "arena/configurable"
+
+module Arena
+  module Cache
+    module Adaptor
+      class Generic
+        include Arena::Configurable
+      end
+    end
+  end
+end

data/lib/arena/cache/adaptor/null.rb

@@ -0,0 +1,13 @@
+require "arena/error/cache_error"
+
+module Arena
+  module Cache
+    module Adaptor
+      class Null
+        def self.method_missing(method, *args, &block)
+          raise Arena::Error::CacheError
+        end
+      end
+    end
+  end
+end

data/lib/arena/cache/adaptor/padrino.rb

@@ -0,0 +1,13 @@
+require "arena/cache/adaptor/generic"
+
+module Arena
+  module Cache
+    module Adaptor
+      class Padrino < Arena::Cache::Adaptor::Generic
+        def self.method_missing(method, *args, &block)
+          # todo
+        end
+      end
+    end
+  end
+end

data/lib/arena/cache/adaptor/rails.rb

@@ -0,0 +1,26 @@
+require "arena/cache/adaptor/generic"
+
+module Arena
+  module Cache
+    module Adaptor
+      class Rails < Arena::Cache::Adaptor::Generic
+        def self.method_missing(method, *args, &block)
+          # Brittle/ugly but works for the time being
+          # 
+          key = args.present? ? "arena_#{method}_#{args.first}" : "arena_#{method}"
+          cache = Rails.cache.read(key)
+
+          if cache.nil?
+            object = args.present? ? Arena.send(method, args.first) : Arena.send(method)
+            
+            Rails.cache.write(key, object, expires_in: Arena.expires_in)
+            
+            cache = Rails.cache.read(key)
+          end
+
+          cache
+        end
+      end
+    end
+  end
+end

data/lib/arena/channel.rb

@@ -13,10 +13,6 @@ module Arena
       :slug, :length, :kind, :status, :user_id, :total_pages,
       :current_page, :per, :follower_count
 
-    def user
-      @user ||= Arena::User.new(@attrs['user'])
-    end
-
     def _class
       @attrs['class']
     end
@@ -29,15 +25,34 @@ module Arena
       @contents ||= @attrs['contents'].collect { |object| "Arena::#{object['class']}".constantize.new(object) }
     end
 
+    def contents_updated_at
+      # todo
+    end
+
+    def connection_count
+      @connection_count ||= contents.collect(&:connections).flatten.size
+    end
+
     def collaborators
       @collaborators ||= @attrs['collaborators'].collect { |user| Arena::User.new(user) }
     end
 
+    def contributors
+      @contributors ||= contents.collect(&:user).uniq(&:id)
+    end
+
+    def flat_connections
+      @flat_connections ||= contents.collect(&:connections).flatten.compact.uniq(&:id)
+    end
+
     %w(image text link media attachment channel).each do |kind|
       define_method "#{kind}s" do
         contents.select { |connectable| connectable._class.downcase == kind }
       end
     end
-    
-  end
-end
+
+    def blocks
+      contents.select { |connectable| connectable._base_class == "Block" }
+    end
+  end # Channel < Arena::Base
+end # Arena

data/lib/arena/client.rb

@@ -1,11 +1,10 @@
-require 'arena/configurable'
-require 'arena/error'
-require 'arena/api'
-require 'httparty'
-require 'json'
+require "arena/configurable"
+require "arena/error"
+require "arena/api"
+require "httparty"
+require "json"
 
 module Arena
-
   class Client
     include HTTParty
     include Arena::Configurable
@@ -18,6 +17,7 @@ module Arena
     end
 
     # Performs HTTP GET POST PUT and DELETE requests
+    # 
     %w(get post put delete).each do |method|
       define_method method do |path, options={}|
         options = { query: options, headers: set_headers }
@@ -30,9 +30,9 @@ module Arena
 
     def set_headers
       if !@access_token.nil?
-        { 'Authorization' => "Bearer #{@access_token}" }
+        { "Authorization" => "Bearer #{@access_token}" }
       elsif !@auth_token.nil?
-        { 'X-AUTH-TOKEN' => @auth_token }
+        { "X-AUTH-TOKEN" => @auth_token }
       else
         { }
       end
@@ -52,12 +52,9 @@ module Arena
 
       raise Arena::Error.new(error_message(parsed)) if error?(response)
       
-      return parsed
-
+      parsed
     rescue JSON::ParserError, TypeError
       nil
     end
-
   end
-
 end

data/lib/arena/comment.rb

@@ -0,0 +1,19 @@
+require "arena/base"
+require "arena/user"
+require "arena/creatable"
+
+module Arena
+  class Comment < Arena::Base
+    include Arena::Creatable
+
+    attr_reader :id, :commentable_id, :commentable_type, :body
+
+    def _class
+      @_class ||= @attrs["class"]
+    end
+
+    def user
+      @user ||= Arena::User.new(@attrs["user"])
+    end
+  end
+end

data/lib/arena/configurable.rb

@@ -1,7 +1,9 @@
 module Arena
   module Configurable
     attr_accessor :base_domain,
-                  :api_version
+                  :api_version,
+                  :use_caching,
+                  :expires_in
 
     attr_writer :application_id,
                 :application_secret,
@@ -16,15 +18,18 @@ module Arena
           :application_id,
           :application_secret,
           :access_token,
-          :auth_token
+          :auth_token,
+          :use_caching,
+          :expires_in
         ]
       end
     end
 
-    # Allows configuration options
-    # to be set in a block
+    # Allows configuration options to be set in a block
+    # 
     def configure
       yield self
+
       self
     end
 
@@ -32,6 +37,7 @@ module Arena
       Arena::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", Arena::Default.options[key])
       end
+      
       self
     end
 
@@ -39,10 +45,8 @@ module Arena
 
   private
 
-    # @return [Hash]
     def options
       Hash[Arena::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
     end
-
   end
 end

data/lib/arena/connectable.rb

@@ -2,6 +2,9 @@ require 'time'
 
 module Arena
   module Connectable
+    def user
+      @user ||= Arena::User.new(@attrs['user']) if !@attrs['user'].nil?
+    end
 
     %w(position selected connection_id).each do |method|
       define_method method do
@@ -16,6 +19,21 @@ module Arena
       end
     end
 
+    # Detect optional portions of the response
+    %w(image attachment embed).each do |kind|
+      define_method "has_#{kind}?" do
+        !@attrs[kind.to_s].nil?
+      end
+    end
+
+    def is_block?
+      _base_class == "Block"
+    end
+
+    def connections
+      @connections ||= @attrs['connections'].collect { |channel| Arena::Channel.new(channel) } if !@attrs['connections'].nil?
+    end
+
     def connected_at
       @connected_at ||= Time.parse(@attrs['connected_at']) if connected?
     end
@@ -29,7 +47,7 @@ module Arena
           'id' => @attrs['connected_by_user_id'],
           'username' => @attrs['connected_by_username'],
           'full_name' => @attrs['connected_by_username']
-        })
+        }) if connected?
     end
 
   private
@@ -37,6 +55,5 @@ module Arena
     def connected?
       !@attrs['connected_at'].nil?
     end
-
-  end
-end
+  end # Connectable
+end # Arena

data/lib/arena/connection.rb

@@ -0,0 +1,10 @@
+require "arena/base"
+
+module Arena
+  class Connection < Arena::Base
+    include Arena::Creatable
+
+    attr_reader :id, :position, :selected, :user_id,
+      :connectable_id, :connectable_type, :channel_id
+  end # Connection
+end # Arena

data/lib/arena/core_ext/string.rb

@@ -1,7 +1,5 @@
 class String
-
   def constantize
     self.split("::").inject(Module) {|acc, val| acc.const_get(val)}
   end unless method_defined?(:constantize)
-
-end
+end

data/lib/arena/default.rb

@@ -2,9 +2,10 @@ module Arena
   module Default
     BASE_DOMAIN = "api.are.na" unless defined? BASE_DOMAIN
     API_VERSION = "v2" unless defined? API_VERSION
+    USE_CACHING = false unless defined? USE_CACHING
+    EXPIRES_IN  = 600 unless defined? EXPIRES_IN # 10 minutes
 
     class << self
-      # @return [Hash]
       def options
         Hash[Arena::Configurable.keys.map{|key| [key, send(key)]}]
       end
@@ -18,20 +19,28 @@ module Arena
       end
 
       def application_id
-        ENV['APPLICATION_ID']
+        ENV["APPLICATION_ID"]
       end
 
       def application_secret
-        ENV['APPLICATION_SECRET']
+        ENV["APPLICATION_SECRET"]
       end
 
       def access_token
-        ENV['APPLICATION_SECRET']
+        ENV["APPLICATION_SECRET"]
       end
 
       def auth_token
-        ENV['AUTH_TOKEN']
+        ENV["AUTH_TOKEN"]
+      end
+
+      def use_caching
+        USE_CACHING
+      end
+
+      def expires_in
+        EXPIRES_IN
       end
     end
   end
-end
+end

data/lib/arena/entities/avatar.rb

@@ -0,0 +1,13 @@
+require "arena/entity"
+
+module Arena
+  class Entity
+    class Avatar < Arena::Entity
+      attr_reader :thumb, :display
+
+      def custom(size=40)
+        thumb.gsub("s=40", "s=#{size}")
+      end
+    end # Avatar
+  end # Entity
+end # Arena

data/lib/arena/entities/embed.rb

@@ -1,11 +1,10 @@
-require 'arena/entity'
-require 'arena/entities/version'
+require "arena/entity"
 
 module Arena
   class Entity
     class Embed < Arena::Entity
       attr_reader :embed, :url, :type, :title, :author_name, :author_url,
         :source_url, :thumbnail_url, :width, :height, :html
-    end
-  end
-end
+    end # Embed
+  end # Entity
+end # Arena

data/lib/arena/entities/image.rb

@@ -9,7 +9,7 @@ module Arena
 
       attr_reader :filename, :content_type
 
-      %w(thumb display original).each do |method|
+      %w(thumb square display large original).each do |method|
         define_method method do
           instance_variable_set("@#{method}", Arena::Entity::Version.new(@attrs[method])) unless instance_variable_get "@#{method}"
           instance_variable_get "@#{method}"

data/lib/arena/error/cache_error.rb

@@ -0,0 +1,10 @@
+require "arena/error"
+
+module Arena
+  class Error
+    # Raised when Cache engine is unavailable
+    # 
+    class CacheError < Arena::Error
+    end
+  end
+end

data/lib/arena/feed.rb

@@ -0,0 +1,36 @@
+require "arena/base"
+require "arena/story"
+require "arena/group"
+
+module Arena
+  class Feed < Arena::Base
+    attr_reader :type, :limit, :total, :offset, :range_start, :range_end
+
+    def stories
+      @stories ||= @attrs["items"].collect { |item| Arena::Story.new(item) } if stories?
+    end
+    
+    alias items stories
+
+    def groups
+      if stories?
+        groups = items.group_by do |item|
+          target = "#{item.target.id}_" if !item.target.nil?
+
+          "#{item.user.id}_#{target}#{item.action.gsub(' ', '_')}"
+        end
+
+        @groups ||=
+          groups.collect { |key, stories| Arena::Group.new(key, stories) }.
+            sort_by { |group| group.summary.indicative.created_at }.reverse!
+      end
+    end
+
+  private
+
+    def stories?
+      !@attrs["items"].nil?
+    end
+
+  end # Feed
+end # Arena

data/lib/arena/group.rb

@@ -0,0 +1,21 @@
+require "arena/story"
+require "arena/summary"
+
+module Arena
+  class Group
+    attr_reader :id, :stories
+
+    def initialize(id, stories)
+      @id = id
+      @stories = stories
+    end
+
+    def created_at
+      @created_at ||= stories.first.created_at
+    end
+
+    def summary
+      @summary ||= Arena::Summary.new(stories)
+    end
+  end # Group
+end # Arena

data/lib/arena/search_results.rb

@@ -1,14 +1,17 @@
-require 'arena/core_ext/string'
-require 'arena/base'
-require 'arena/channel'
-require 'arena/user'
-require 'arena/block'
+require "arena/core_ext/string"
+require "arena/base"
+require "arena/channel"
+require "arena/user"
+require "arena/block"
 
 module Arena
   class SearchResults < Arena::Base
-    def term
-      @attrs['term'] unless @attrs['term'].nil?
-    end
+    attr_reader :term,
+                :per,
+                :current_page,
+                :total_pages,
+                :length,
+                :authenticated
 
     %w(user channel block).each do |method|
       define_method "#{method}s" do
@@ -18,5 +21,5 @@ module Arena
         instance_variable_get "@#{method}s"
       end
     end
-  end
-end
+  end # SearchResults
+end # Arena

data/lib/arena/story.rb

@@ -0,0 +1,31 @@
+require "arena/base"
+require "arena/creatable"
+require "arena/user"
+require "arena/block"
+require "arena/channel"
+require "arena/connection"
+
+module Arena
+  class Story < Arena::Base
+    include Arena::Creatable
+
+    attr_reader :id, :action, :bulletin_id, :connector, :created_at
+
+    def user
+      @user ||= Arena::User.new(@attrs["user"])
+    end
+
+    %w(item target parent).each do |method|
+      define_method method do
+        if !@attrs[method].nil?
+          type = "#{method}_type"
+
+          instance_variable_set("@#{method}",
+              "Arena::#{@attrs[type]}".constantize.new(@attrs[method])
+            ) unless instance_variable_get "@#{method}"
+          instance_variable_get "@#{method}"
+        end
+      end
+    end
+  end # Story
+end # Arena

data/lib/arena/summary.rb

@@ -0,0 +1,11 @@
+module Arena
+  class Summary
+    attr_reader :indicative, :kinds, :size
+
+    def initialize(stories)
+      @indicative = stories.first
+      @kinds      = stories.collect { |story| story.item._class }.uniq
+      @size       = stories.size
+    end
+  end # Summary
+end # Arena

data/lib/arena/user.rb

@@ -1,16 +1,22 @@
-require 'arena/base'
-require 'arena/creatable'
+require "arena/base"
+require "arena/creatable"
+require "arena/entity"
+require "arena/entities/avatar"
 
 module Arena
   class User < Arena::Base
     include Arena::Creatable
 
     attr_reader :id, :slug, :username, :first_name, :last_name,
-    :full_name, :avatar, :email, :channel_count, :following_count,
-    :profile_id, :follower_count, :initials
+      :full_name, :avatar, :email, :channel_count, :following_count,
+      :profile_id, :follower_count, :initials
 
     def _class
-      @attrs['class']
+      @attrs["class"]
     end
-  end
-end
+
+    def avatar_image
+      Arena::Entity::Avatar.new(@attrs["avatar_image"]) if !@attrs["avatar_image"].nil?
+    end
+  end # User
+end # Arena

data/lib/arena/version.rb

@@ -1,5 +1,5 @@
 module Arena
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 
   def self.version
     VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arena
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-06 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,17 +73,26 @@ files:
 - Rakefile
 - arena.gemspec
 - lib/arena.rb
+- lib/arena/account.rb
 - lib/arena/api.rb
 - lib/arena/base.rb
 - lib/arena/block.rb
+- lib/arena/cache.rb
+- lib/arena/cache/adaptor/generic.rb
+- lib/arena/cache/adaptor/null.rb
+- lib/arena/cache/adaptor/padrino.rb
+- lib/arena/cache/adaptor/rails.rb
 - lib/arena/channel.rb
 - lib/arena/client.rb
+- lib/arena/comment.rb
 - lib/arena/configurable.rb
 - lib/arena/connectable.rb
+- lib/arena/connection.rb
 - lib/arena/core_ext/string.rb
 - lib/arena/creatable.rb
 - lib/arena/default.rb
 - lib/arena/entities/attachment.rb
+- lib/arena/entities/avatar.rb
 - lib/arena/entities/embed.rb
 - lib/arena/entities/image.rb
 - lib/arena/entities/provider.rb
@@ -91,8 +100,13 @@ files:
 - lib/arena/entities/version.rb
 - lib/arena/entity.rb
 - lib/arena/error.rb
+- lib/arena/error/cache_error.rb
+- lib/arena/feed.rb
+- lib/arena/group.rb
 - lib/arena/results.rb
 - lib/arena/search_results.rb
+- lib/arena/story.rb
+- lib/arena/summary.rb
 - lib/arena/user.rb
 - lib/arena/version.rb
 - test/lib/arena/version_test.rb
@@ -117,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Wrapper for Arena's API