adn 0.3.4 → 0.3.5

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### Changelog
+
+* **Version 0.3.5** (23 October 2012)
+ * Added the unified stream
+* **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.

data/Gemfile

@@ -3,5 +3,5 @@ gemspec
 
 group :test do
   gem 'rake'
-  gem 'minitest', '~> 3.3'
+  gem 'minitest', '~> 4.1'
 end

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    adn (0.3.4)
+    adn (0.3.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    minitest (3.3.0)
+    minitest (4.1.0)
     rake (0.9.2.2)
 
 PLATFORMS
@@ -14,5 +14,5 @@ PLATFORMS
 
 DEPENDENCIES
   adn!
-  minitest (~> 3.3)
+  minitest (~> 4.1)
   rake

data/README.md

@@ -39,22 +39,6 @@ For API calls that accept parameters described in the App.net API Spec, simply p
 
 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.  

data/lib/adn.rb

@@ -30,14 +30,10 @@ require 'date'
 %w{constants api post user version}.each { |f| require_relative "adn/#{f}" }
 
 module ADN
-  class Error < StandardError; end
+  Error = Class.new StandardError
 
-  def self.token=(token)
-    @token = token
-  end
-
-  def self.token
-    @token
+  class << self
+    attr_accessor :token
   end
 
   def self.create_instance(data, type)
@@ -45,6 +41,6 @@ module ADN
   end
 
   def self.create_collection(data, type)
-    data.collect { |t| type.new(t) }
+    data.map { |t| type.new(t) }
   end
 end

data/lib/adn/api.rb

@@ -6,7 +6,7 @@ end
 
 module ADN
   module API
-    class Error < StandardError; end
+    Error = Class.new StandardError
 
     class << self
       def perform(request)
@@ -18,26 +18,36 @@ module ADN
         }
       end
 
+      def construct_request(verb, url)
+        http_method = case verb
+          when :post then Net::HTTP::Post
+          when :put then Net::HTTP::Put
+          when :delete then Net::HTTP::Delete
+          else Net::HTTP::Get
+        end
+        http_method.new(url)
+      end
+
       def get(url, params = nil)
         url = params.nil? ? url : [url, URI.encode_www_form(params)].join("?")
-        request = Net::HTTP::Get.new(url)
+        request = construct_request(:get, url)
         perform(request)
       end
 
       def post(url, params = nil)
-        request = Net::HTTP::Post.new(url)
+        request = construct_request(:post, url)
         request.set_form_data(params) if params
         perform(request)
       end
 
       def put(url, params = nil)
-        request = Net::HTTP::Put.new(url)
+        request = construct_request(:put, url)
         request.set_form_data(params) if params
         perform(request)
       end
 
       def delete(url)
-        request = Net::HTTP::Delete.new(url)
+        request = construct_request(:delete, url)
         perform(request)
       end
     end

data/lib/adn/api/post.rb

@@ -39,9 +39,13 @@ module ADN
         ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/stream/global", params)
       end
 
+      def self.unified_stream(params = nil)
+        ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/stream/unified", params)
+      end
+
       def self.by_hashtag(hashtag, params = nil)
         ADN::API.get("#{ADN::API_ENDPOINT_POSTS}/tag/#{hashtag}", params)
       end
     end
   end
-end
+end

data/lib/adn/api/user.rb

@@ -7,10 +7,6 @@ module ADN
         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

data/lib/adn/post.rb

@@ -2,9 +2,15 @@
 
 module ADN
   class Post
-    attr_accessor :post_id, :created_at, :entities,
-                  :html, :id, :num_replies, :reply_to,
-                  :source, :text, :thread_id, :user
+    attr_accessor(
+      :id, :post_id, :text, :html, :source, :machine_only,
+      :reply_to, :thread_id, :canonical_url,
+      :num_replies, :num_reposts, :num_stars,
+      :annotations, :entities, :you_reposted,
+      :you_starred, :reposters, :starred_by
+    )
+      
+    attr_writer :user, :created_at
 
     def self.send_post(params)
       result = ADN::API::Post.create(params)
@@ -26,7 +32,10 @@ module ADN
 
     def details
       if id
-        Hash[self.instance_variables.map { |i| [i.to_s.slice(1..-1), self.instance_variable_get(i)]}]
+        value = self.instance_variables.map do |i|
+          [i.to_s.slice(1..-1), self.instance_variable_get(i)]
+        end
+        Hash[value]
       else
         ADN::API::Post.by_id(post_id)
       end

data/lib/adn/user.rb

@@ -2,36 +2,25 @@
 
 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
+    attr_accessor(
+      :id, :user_id, :username, :name, :description,
+      :timezone, :locale, :avatar_image,
+      :cover_image, :type, :counts, :app_data,
+      :follows_you, :you_follow, :you_muted
+    )
+      
+    attr_writer :created_at
 
     def self.me
-      new ADN::API::Token.current['user']
+      new ADN::API::Token.current["user"]
     end
 
-    def initialize(user)
-      if user.respond_to?(:each_pair)
-        set_values(user)
-        self.user_id = id.to_s
-      else
-        self.user_id = user.to_s
-        user_details = details
-        if details.has_key? "data"
-          set_values(user_details["data"])
-        end
-      end
+    def self.find(user_id)
+      new ADN::API::User.retrieve(user_id)
     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
+    def initialize(user_data = {})
+      set_values(user_data)
     end
 
     def created_at
@@ -40,20 +29,16 @@ module ADN
 
     # 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")
+      result = ADN.post("#{ADN::API_ENDPOINT_USERS}/#{user.user_id}/follow")
       ADN.create_instance(result["data"], User)
     end
 
     def unfollow(user)
-      user_id = get_user(user)
-      result = ADN.delete("/stream/0/users/#{user_id}/follow")
-      ADN.create_instance(result["data"], User)
+      if user.valid_user?
+        result = ADN.delete("#{ADN::API_ENDPOINT_USERS}/#{user.user_id}/follow")
+        ADN.create_instance(result["data"], User)
+      end
     end
 
     def followers
@@ -69,15 +54,17 @@ module ADN
     # 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)
+      if user.valid_user?
+        result = ADN.post("#{ADN::API_ENDPOINT_USERS}/#{user.user_id}/mute")
+        ADN.create_instance(result["data"], User)
+      end
     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)
+      if user.valid_user?
+        result = ADN.delete("#{ADN::API_ENDPOINT_USERS}/#{user.user_id}/mute")
+        ADN.create_instance(result["data"], User)
+      end
     end
 
     def mute_list
@@ -102,12 +89,15 @@ module ADN
       ADN.create_collection(result["data"], Post)
     end
 
-    def set_values(values)
-      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    def valid_user?
+      !!user_id.match(/^\d+$/)
     end
 
-    def has_error?
-      self.id.nil?
+    def set_values(values)
+      if values.respond_to? :each_pair
+        values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+        self.user_id = id.to_s
+      end
     end
   end
 end

data/lib/adn/version.rb

@@ -3,7 +3,7 @@
 module ADN
   MAJOR = 0
   MINOR = 3
-  TINY  = 4
+  TINY  = 5
   VERSION = [MAJOR, MINOR, TINY].join('.')
 end
 

data/spec/adn/api/post_spec.rb

@@ -90,6 +90,17 @@ describe ADN::API::Post do
     end
   end
 
+  describe "unified_stream" do
+    it "retrieves the unified stream" do
+      args(:get) {
+        path, params = subject.unified_stream('baz')
+
+        path.must_equal base_path + "/stream/unified"
+        params.must_equal 'baz'
+      }
+    end
+  end
+
   describe "by_hashtag" do
     it "retrieves posts by hashtag" do
       args(:get) {

data/spec/adn/api/token_spec.rb

@@ -7,13 +7,15 @@ describe ADN::API::Token do
 
   describe "current" do
     it "does not return the current token if it has an error" do
-      ADN::API.stub(:get, ADN::API::Response.new({ "error" => "error message" })) do
+      ADN::API.stub(
+        :get, ADN::API::Response.new("error" => "error message")) do
         subject.current.must_equal nil
       end
     end
 
     it "retrieves the current token" do
-      ADN::API.stub(:get, ADN::API::Response.new({ "data" => "example_token" })) do
+      ADN::API.stub(
+        :get, ADN::API::Response.new("data" => "example_token")) do
         subject.current.must_equal "example_token"
       end
     end

data/spec/adn/api/user_spec.rb

@@ -13,14 +13,6 @@ describe ADN::API::User do
     end
   end
 
-  describe "by_id" do
-    it "is just an alias for retrieve" do
-      subject.stub(:retrieve, 'foo') do
-        subject.by_id(123).must_equal 'foo'
-      end
-    end
-  end
-
   describe "following" do
     it "retrieves the following list" do
       arg(:get) { subject.following(44).must_equal base_path + "44/following" }

data/spec/adn/post_spec.rb

@@ -95,7 +95,8 @@ describe ADN::Post do
 
   describe "replies" do
     it "returns a list of posts" do
-      response = ADN::API::Response.new("data" => [{ text: "foo"}, {text: "bar"}])
+      response = ADN::API::Response.new(
+        "data" => [{ text: "foo"}, {text: "bar"}])
 
       ADN::API::Post.stub(:replies, ->(*a){ response }) do
         r = post.replies

data/spec/adn/user_spec.rb

@@ -5,9 +5,9 @@ require_relative '../spec_helper'
 describe ADN::User do
   subject { ADN::User }
 
-  let(:empty_user) { subject.new({}) }
-  let(:user) { subject.new(user_data) }
-  let(:user_data) { fixture('user.json') }
+  let(:empty_user) { subject.new({})        }
+  let(:user)       { subject.new(user_data) }
+  let(:user_data)  { fixture('user.json')   }
 
   describe "me" do
     it "retrieves the user based on the current token" do
@@ -19,24 +19,21 @@ describe ADN::User do
     end
   end
 
-  describe "initialize" do
-    it "populates the accessors based on the raw user data passed in" do
-      u = subject.new(user_data)
-      u.user_id.must_equal "4821"
-    end
-
-    # TODO: Remove this behavior, wrong level of abstraction
-    it "populates the accessors based on the user id passed in" do
-      ADN::API::User.stub(:retrieve, { "data" => user_data }) do
-        u = subject.new(4821)
+  describe "find" do
+    it "retrieves the user data from the API and returns a User object" do
+      ADN::API::User.stub(:retrieve, user_data) do
+        u = subject.find("4821")
         u.name.must_equal "Peter Hellberg"
         u.user_id.must_equal "4821"
       end
     end
   end
 
-  describe "details" do
-    it "spec_name" do
+  describe "initialize" do
+    it "populates the accessors based on the raw user data passed in" do
+      u = subject.new(user_data)
+      u.name.must_equal "Peter Hellberg"
+      u.user_id.must_equal "4821"
     end
   end
 
@@ -46,16 +43,6 @@ describe ADN::User do
     end
   end
 
-  # TODO: Change the name to describe what
-  #       it actually returns (user_id) or
-  #       remove it completely
-  describe "get_user" do
-    it "returns a user id for some reason" do
-      empty_user.get_user(user).must_equal "4821"
-      empty_user.get_user(123).must_equal 123
-    end
-  end
-
   describe "follow" do
     it "" do
     end
@@ -115,13 +102,13 @@ describe ADN::User do
     end
   end
 
-  describe "has_error?" do
-    it "returns true if no id" do
-      empty_user.has_error?.must_equal true
+  describe "valid_user?" do
+    it "returns false if no id" do
+      empty_user.valid_user?.must_equal false
     end
 
-    it "returns false if the user has an id" do
-      user.has_error?.must_equal false
+    it "returns true if the user has an id" do
+      user.valid_user?.must_equal true
     end
   end
 end

data/spec/adn_spec.rb

@@ -23,7 +23,7 @@ describe ADN do
     ADN::API_ENDPOINT_POSTS.must_equal '/stream/0/posts'
     ADN::API_ENDPOINT_USERS.must_equal '/stream/0/users'
   end
-  
+
   it "has constants containing the API endpoints for tokens" do
     ADN::API_ENDPOINT_TOKEN.must_equal '/stream/0/token'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adn
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies: []
 description: A simple and easy to use library to interact with App.net's API
 email:
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2288184448617261034
+      hash: 2181708405046728371
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24