adn 0.0.1 → 0.3.2

data/.gitignore

@@ -2,12 +2,8 @@
 *.rbc
 .bundle
 .config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc
@@ -15,3 +11,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without documentation
+rvm:
+  - 1.9.3
+branches:
+  only:
+    - master

data/Gemfile

@@ -1,4 +1,7 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in adn.gemspec
+source :rubygems
 gemspec
+
+group :test do
+  gem 'rake'
+  gem 'minitest', '~> 3.3'
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    adn (0.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (3.3.0)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adn!
+  minitest (~> 3.3)
+  rake

data/README.md

@@ -1,29 +1,66 @@
-# Adn
+ADN
+===
 
-TODO: Write a gem description
+[![Build Status](https://secure.travis-ci.org/kishyr/ADNRuby.png)](http://travis-ci.org/kishyr/ADNRuby)
 
-## Installation
+A Ruby library for App.net by [@kishyr](https://alpha.app.net/kishyr). 
 
-Add this line to your application's Gemfile:
+This library follows the current [App.net API Spec](https://github.com/appdotnet/api-spec) (as at 26 August 2012).  
 
-    gem 'adn'
+### Contributors
 
-And then execute:
+ADN is brought to you by these very handsome gentlemen:
 
-    $ bundle
+* Kishyr Ramdial ([@kishyr](https://alpha.app.net/kishyr))
+* Dave Goodchild ([@buddhamagnet](https://alpha.app.net/buddhamagnet))
+* Peter Hellberg ([@peterhellberg](https://alpha.app.net/peterhellberg))
 
-Or install it yourself as:
+### Installation
 
-    $ gem install adn
+Simply add ADN to your Gemfile:
 
-## Usage
+`gem "adn"`
 
-TODO: Write usage instructions here
+Or you can install ADN directly from rubygems.org:
 
-## Contributing
+`gem install adn`
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+### Usage
+For API calls that accept parameters described in the App.net API Spec, simply pass them as a dictionary to the method.  
+
+```ruby
+  require 'adn'
+
+  ADN.token = "your App.net OAuth-token here."
+
+  # TODO: Actually describe the usage of the library
+  #       (Should be refactored first)
+```
+
+Complete documentation will be available soon, but in the meantime you can browse all API methods in `lib/adnruby.rb`.
+
+### Changelog
+
+* **Version 0.3.1** (28 August 2012)  
+  * Fixed naming conflict
+* **Version 0.3** (28 August 2012)  
+  * Now includes a Post class that describes each post along with a bunch of new methods of accessing a post's replies and the post's original post.  
+  * Users methods that return user details (follow, unfollow, following, followers, mute, unmute, mute_list) will now return either a User object back, or an array of User objects.  
+  * Similarly, User methods that return post details (posts, mentions, stream) will return a Post object, or an array of Post objects.  
+  * To accomplish all this, I've had to change the module structure which will break existing code if you've relied on the modules to access any data. Basically, all modules begin with ADN::API:: now (eg. ADN::API::Post, ADN::API::User).  
+* **Version 0.2** (27 August 2012)  
+  * Changed all existing classes to modules and introduced the User class for easily accessing user details
+* **Version 0.1** (26 August 2012)  
+  * Really basic functionality for all existing App.new API methods as per the spec.
+
+---
+
+### License
+
+**ADN** is licensed under the MIT License and is Copyright (c) 2012 Kishyr Ramdial.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,2 +1,24 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'find'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run cane to check quality metrics"
+task :quality do
+  Bundler.with_clean_env do
+    exec 'cane'
+  end
+end
+
+desc "Run tests in a loop using kicker (>= 3.0.0pre1)"
+task :kicker do
+  Bundler.with_clean_env do
+    exec 'kicker --no-notification -r ruby -e "clear && rake" spec lib'
+  end
+end

data/adn.gemspec

@@ -1,17 +1,17 @@
-# -*- encoding: utf-8 -*-
+# encoding: UTF-8
+
 require File.expand_path('../lib/adn/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Justin Balthrop"]
-  gem.email         = ["git@justinbalthrop.com"]
-  gem.description   = %q{App.net command line}
-  gem.summary       = %q{Command line client for App.net}
-  gem.homepage      = "http://github.com/ninjudd/adn"
+Gem::Specification.new do |s|
+  s.name        = 'adn'
+  s.version     = ADN::VERSION
+  s.authors     = ["Kishyr Ramdial", "Dave Goodchild", "Peter Hellberg"]
+  s.email       = ["kishyr@gmail.com", "buddhamagnet@gmail.com", "peter@c7.se"]
+  s.description = "A simple and easy to use library to interact with App.net's API"
+  s.summary     = "A Ruby library for App.net"
+  s.homepage    = "https://github.com/kishyr/ADNRuby"
+  s.files       = `git ls-files`.split($\)
+  s.test_files  = s.files.grep(%r{^(spec)/})
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "adn"
-  gem.require_paths = ["lib"]
-  gem.version       = Adn::VERSION
+  s.required_ruby_version = '>= 1.9.3'
 end

data/lib/adn/api/filter.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Filter
+      # Not Yet Implemented
+      # https://github.com/appdotnet/api-spec/blob/master/resources/filters.md
+    end
+  end
+end

data/lib/adn/api/post.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Post
+      def self.create(params)
+        ADN::API.post("#{ADN::API_ENDPOINT_POSTS}", params)
+      end
+
+      def self.retrieve(post_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/#{post_id}")
+      end
+
+      def self.by_id(post_id)
+        self.retrieve(post_id)
+      end
+
+      def self.delete(post_id)
+        ADN::API.delete("#{ADN::API_ENDPOINT_POSTS}/#{post_id}")
+      end
+
+      def self.replies(post_id, params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/#{post_id}/replies", params)
+      end
+
+      def self.by_user(user_id, params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_USERS}/#{user_id}/posts", params)
+      end
+
+      def self.mentioning_user(user_id, params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_USERS}/#{user_id}/mentions", params)
+      end
+
+      def self.stream(params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/stream", params)
+      end
+
+      def self.global_stream(params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/stream/global", params)
+      end
+
+      def self.by_hashtag(hashtag, params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/tag/#{hashtag}", params)
+      end
+    end
+  end
+end

data/lib/adn/api/response.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require 'delegate'
+
+module ADN
+  module API
+    class Response < SimpleDelegator
+      def has_error?
+        has_key?("error")
+      end
+    end
+  end
+end

data/lib/adn/api/stream.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Stream
+      # Not Yet Implemented
+      # https://github.com/appdotnet/api-spec/blob/master/resources/streams.md
+    end
+  end
+end

data/lib/adn/api/subscription.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Subscription
+      # Not Yet Implemented
+      # https://github.com/appdotnet/api-spec/
+      # blob/master/resources/subscriptions.md
+    end
+  end
+end

data/lib/adn/api/token.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Token
+      def self.current
+        result = ADN::API.get(ADN::API_ENDPOINT_TOKEN)
+        result["data"] unless result.has_error?
+      end
+    end
+  end
+end

data/lib/adn/api/user.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module User
+      def self.retrieve(user_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_USERS}/#{user_id}")
+      end
+
+      def self.by_id(user_id)
+        self.retrieve(user_id)
+      end
+
+      def self.following(user_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_USERS}/#{user_id}/following")
+      end
+
+      def self.followers(user_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_USERS}/#{user_id}/followers")
+      end
+    end
+  end
+end

data/lib/adn/api.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+%w{response filter post stream subscription token user}.each do |f|
+  require_relative "api/#{f}"
+end
+
+module ADN
+  module API
+    class Error < StandardError; end
+
+    class << self
+      def perform(request)
+        request.add_field("Authorization", "Bearer #{ADN.token}")
+        response = JSON.parse ADN::HTTP.request(request).body
+
+        Response.new(response).tap { |r|
+          raise ADN::API::Error, r['error'] if r.has_error?
+        }
+      end
+
+      def get(url, params = nil)
+        url = params.nil? ? url : [url, URL.encode_www_form(params)].join("?")
+        request = Net::HTTP::Get.new(url)
+        perform(request)
+      end
+
+      def post(url, params = nil)
+        request = Net::HTTP::Post.new(url)
+        request.set_form_data(params) if params
+        perform(request)
+      end
+
+      def put(url, params = nil)
+        request = Net::HTTP::Put.new(url)
+        request.set_form_data(params) if params
+        perform(request)
+      end
+
+      def delete(url)
+        request = Net::HTTP::Delete.new(url)
+        perform(request)
+      end
+    end
+  end
+end

data/lib/adn/constants.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+require 'net/https'
+
+module ADN
+  API_HOST = "alpha-api.app.net"
+  API_ENDPOINT = "/stream/0"
+  API_ENDPOINT_POSTS = "#{API_ENDPOINT}/posts"
+  API_ENDPOINT_USERS = "#{API_ENDPOINT}/users"
+  API_ENDPOINT_TOKEN = "#{API_ENDPOINT}/token"
+  HTTP = Net::HTTP.new(API_HOST, 443)
+
+  HTTP.use_ssl = true
+end

data/lib/adn/post.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+
+module ADN
+  class Post
+    attr_accessor :post_id, :created_at, :entities,
+                  :html, :id, :num_replies, :reply_to,
+                  :source, :text, :thread_id, :user
+
+    def self.send_post(params)
+      result = ADN::API::Post.create(params)
+      Post.new(result["data"]) unless result.has_error?
+    end
+
+    def initialize(raw_post)
+      if raw_post.respond_to?(:each_pair)
+        set_values(raw_post)
+        post_id = id
+      else
+        post_id = raw_post
+        post_details = details
+        if post_details.has_key? "data"
+          set_values(post_details["data"])
+        end
+      end
+    end
+
+    def details
+      if id
+        Hash[self.instance_variables.map { |i| [i.to_s.slice(1..-1), self.instance_variable_get(i)]}]
+      else
+        ADN::API::Post.by_id(post_id)
+      end
+    end
+
+    def created_at
+      DateTime.parse(@created_at)
+    end
+
+    def user
+      ADN::User.new(@user)
+    end
+
+    def reply_to_post
+      result = ADN::API::Post.by_id(reply_to)
+      ADN.create_instance(result["data"], Post) unless result.has_error?
+    end
+
+    def replies(params = nil)
+      result = ADN::API::Post.replies(id, params)
+      ADN.create_collection(result["data"], Post) unless result.has_error?
+    end
+
+    def delete
+      result = ADN::API::Post.delete(id)
+      ADN.create_instance(result["data"], Post) unless result.has_error?
+    end
+
+    def set_values(values)
+      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+  end
+end

data/lib/adn/user.rb

@@ -0,0 +1,109 @@
+# encoding: UTF-8
+
+module ADN
+  class User
+    attr_accessor :user_id
+    attr_accessor :avatar_image, :counts, :cover_image,
+                  :created_at, :description, :follows_you,
+                  :id, :is_follower, :is_following, :is_muted,
+                  :locale, :name, :timezone, :type, :username,
+                  :you_follow, :you_muted
+
+    def initialize(user)
+      if user.respond_to?(:each_pair)
+        set_values(user)
+        self.user_id = id
+      else
+        self.user_id = user
+        user_details = details
+        if details.has_key? "data"
+          set_values(user_details["data"])
+        end
+      end
+    end
+
+    def details
+      if id
+        Hash[self.instance_variables.map { |i| [i.to_s.slice(1..-1), self.instance_variable_get(i)]}]
+      else
+        ADN::API::User.retrieve(user_id)
+      end
+    end
+
+    def created_at
+      DateTime.parse(@created_at)
+    end
+
+    # Followers/Users
+
+    def get_user(user)
+      user.is_a?(ADN::User) ? user.id : user
+    end
+
+    def follow(user)
+      user_id = get_user(user)
+      result = ADN.post("/stream/0/users/#{user_id}/follow")
+      ADN.create_instance(result["data"], User) unless result.has_error?
+    end
+
+    def unfollow(user)
+      user_id = get_user(user)
+      result = ADN.delete("/stream/0/users/#{user_id}/follow")
+      ADN.create_instance(result["data"], User) unless result.has_error?
+    end
+
+    def followers
+      result = ADN::API::User.followers(user_id)
+      ADN.create_collection(result["data"], User) unless result.has_error?
+    end
+
+    def following
+      result = ADN::API::User.following(user_id)
+      ADN.create_collection(result["data"], User) unless result.has_error?
+    end
+
+    # Mute
+
+    def mute(user)
+      user_id = get_user(user)
+      result = ADN.post("#{ADN::API_ENDPOINT_USERS}/#{user_id}/mute")
+      ADN.create_instance(result["data"], User) unless result.has_error?
+    end
+
+    def unmute(user)
+      user_id = get_user(user)
+      result = ADN.delete("#{ADN::API_ENDPOINT_USERS}/#{user_id}/mute")
+      ADN.create_instance(result["data"], User) unless result.has_error?
+    end
+
+    def mute_list
+      result = ADN.get("#{ADN::API_ENDPOINT_USERS}/me/muted")
+      ADN.create_collection(result["data"], User) unless result.has_error?
+    end
+
+    # Posts
+
+    def posts(params = nil)
+      result = ADN::API::Post.by_user(user_id, params)
+      ADN.create_collection(result["data"], Post) unless result.has_error?
+    end
+
+    def stream(params = nil)
+      result = ADN::API::Post.stream(params)
+      ADN.create_collection(result["data"], Post) unless result.has_error?
+    end
+
+    def mentions(params = nil)
+      result = ADN::API::Post.mentioning_user(user_id, params)
+      ADN.create_collection(result["data"], Post) unless result.has_error?
+    end
+
+    def set_values(values)
+      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+
+    def has_error?
+      self.id.nil?
+    end
+  end
+end

data/lib/adn/version.rb

@@ -1,3 +1,9 @@
-module Adn
-  VERSION = "0.0.1"
+# encoding: UTF-8
+
+module ADN
+  MAJOR = 0
+  MINOR = 3
+  TINY = 2
+  VERSION = [MAJOR, MINOR, TINY].join('.')
 end
+

data/lib/adn.rb

@@ -1,5 +1,54 @@
-require "adn/version"
 
-module Adn
-  # Your code goes here...
+#
+# ADN - A simple and easy to use App.net Ruby library
+#
+# Copyright (c) 2012 Kishyr Ramdial
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'uri'
+require 'json'
+require 'date'
+
+%w{constants api post user version}.each { |f| require_relative "adn/#{f}" }
+
+module ADN
+  class Error < StandardError; end
+
+  def self.token=(token)
+    @token = token
+  end
+
+  def self.token
+    @token
+  end
+
+  def self.has_error?(hash)
+    hash.has_key?("error")
+  end
+
+  def self.create_instance(data, type)
+    type.new(data)
+  end
+
+  def self.create_collection(data, type)
+    data.collect { |t| type.new(t) }
+  end
 end

data/spec/adn/api/filter_spec.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+require_relative '../../spec_helper'
+
+describe ADN::API::Filter do
+  subject { ADN::API::Filter }
+
+  # Not Implemented Yet
+end