githubris 0.0.2 → 0.0.3

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+script: 'rake all'
 rvm:
   - 1.9.2
   - 1.9.3

data/Rakefile

@@ -6,8 +6,15 @@ RSpec::Core::RakeTask.new :spec do |t|
   t.rspec_opts = '--color --format=documentation'
 end
 
+namespace :features do
+  Cucumber::Rake::Task.new :wip do |t|
+    t.cucumber_opts = '--tags @wip --tags ~@backlog'
+  end
+end
+
 Cucumber::Rake::Task.new :features do |t|
   t.cucumber_opts = '--tags ~@wip --tags ~@backlog'
 end
 
+task :all => [:spec, :features]
 task :default => :spec

data/features/get_a_user.feature

@@ -0,0 +1,8 @@
+Feature: Get a user
+  In order to retrieve data about a user
+  As a developer
+  I want to be able to get a user's data
+
+  Scenario: Getting a user
+    When I access "@githubris.find_user('GithubrisTestUser')"
+    Then I have that user

data/features/list_of_public_gists.feature

@@ -5,8 +5,8 @@ Feature: List of Public Gists
 
   Scenario: Asking for public gists
     When I access "@githubris.public_gists"
-    Then I should have a default number of gists
+    Then I have the default number of gists
 
-  Scenario: Asking for a certain quantity of public gists
-    When I access "@githubris.public_gists(quantity: 47)"
-    Then I should have 47 gists
+  Scenario: Asking for a certain page of public gists
+    When I access "@githubris.public_gists(page: 60)"
+    Then I have the default number of gists

data/features/list_of_users_public_gists.feature

@@ -1,4 +1,3 @@
-@backlog
 Feature: List of user's public gists
   In order to view all of the public gists another user has made,
   As a user of the Githubris GitHub API,
@@ -6,9 +5,9 @@ Feature: List of user's public gists
 
   Scenario: via Githubris
     When I access "@githubris.public_gists(user: 'GithubrisTestUser')"
-    Then I have GithubrisTestUser's public gists
+    Then I have 2 gists
 
   Scenario: via the User
     Given @user is GithubrisTestUser
     When I access "@user.public_gists"
-    Then I have GithubrisTestUser's public gists
+    Then I have 2 gists

data/features/step_definitions/general_steps.rb

@@ -6,15 +6,14 @@ When /^I access "([^"]*)"$/ do |api_code|
   @actual = binding.eval api_code
 end
 
-Then /^I have GithubrisTestUser's public gists$/ do
-  @actual.should eql test_public_gists
-end
-
-Then /^I should have a default number of gists$/ do
+Then /^I have the default number of gists$/ do
   @actual.count.should eql 30
 end
 
-Then /^I should have (\d+) gists$/ do |count|
+Then /^I have (\d+) gists$/ do |count|
   @actual.count.should eql Integer(count)
 end
 
+Then /^I have that user$/ do
+  @actual.should == test_user
+end

data/features/support/env.rb

@@ -1,6 +1,6 @@
-$:.push '../../support'
 
 require 'githubris'
+
 Before do
   @githubris = Githubris.new
 end

data/features/support/fakeweb_responses.rb

@@ -3,4 +3,8 @@ require 'fakeweb'
 FakeWeb.allow_net_connect = false
 FakeWeb.register_uri(:get, 'https://api.github.com/', :body => '{}')
 FakeWeb.register_uri(:get, /gists\/public(?:[^?]*\?page=(\d+))?/,
-                     :body => File.open("features/support/public_gists_page_#{$1 || 1}.json", 'r') {|f| f.read })
+                     :body => File.open("spec/support/public_gists_page_#{$1 || 1}.json", 'r') {|f| f.read })
+FakeWeb.register_uri(:get, /users\/([^\/]*)\/gists\z/,
+                     :body => File.open("spec/support/user_public_gists.json"){|f| f.read })
+FakeWeb.register_uri(:get, /users\/\w+\z/,
+                     :body => File.open("spec/support/user.json"){|f| f.read })

data/features/support/fixtures.rb

@@ -1,10 +1,34 @@
 module Fixtures
   def test_public_gists
-    Githubris::Builder.new.build get_public_gists_data
+    build_gists get_public_gists_data
+  end
+
+  def test_user_public_gists
+    build_gists get_user_public_gists_data
+  end
+
+  def test_user
+    build_user get_user_data
+  end
+
+  def build_gists data
+    Githubris::Builder.new.build_gists data
+  end
+
+  def build_user data
+    Githubris::Builder.new.build_user data
+  end
+
+  def get_user_public_gists_data
+    MultiJson.decode(File.open("spec/support/user_public_gists.json") {|f| f.read})
   end
 
   def get_public_gists_data(page=1)
-    MultiJson.decode(File.open("features/support/public_gists_page_#{page}.json") {|f| f.read })
+    MultiJson.decode(File.open("spec/support/public_gists_page_#{page}.json") {|f| f.read })
+  end
+
+  def get_user_data
+    MultiJson.decode(File.open('spec/support/user.json') {|f| f.read })
   end
 end
 

data/lib/githubris/api/gist.rb

@@ -0,0 +1,31 @@
+require 'githubris/builder/gist'
+
+module Githubris::API::Gist
+  PUBLIC_GISTS_PATH = '/gists/public'
+
+  def get_user_public_gists(login)
+    data = self.class.get user_gists_path(login)
+    gists = @builder.build_gists(data)
+    gists.map do |gist|
+      gist.set_attribute(:user, get_user(login))
+      gist
+    end
+  end
+
+  def get_public_gists(options={})
+    login = options.delete(:user)
+    return get_user_public_gists(login) if login
+
+    data = self.class.get public_gists_path_for_page(options[:page])
+    @builder.build_gists data
+  end
+
+  private
+  def public_gists_path_for_page page_number=1
+    "#{PUBLIC_GISTS_PATH}?page=#{page_number}"
+  end
+
+  def user_gists_path(login)
+    "/users/#{login}/gists"
+  end
+end

data/lib/githubris/api/user.rb

@@ -0,0 +1,15 @@
+require 'githubris/builder/user'
+
+module Githubris::API::User
+  USERS_PATH = '/users'
+
+  def get_user(login)
+    data = self.class.get user_path(login)
+    @builder.build_user data
+  end
+
+  private
+  def user_path(login)
+    "#{USERS_PATH}/#{login}"
+  end
+end

data/lib/githubris/api.rb

@@ -2,12 +2,16 @@ require 'httparty'
 
 class Githubris::API
   include HTTParty
+
+  require_relative 'api/gist'
+  include Githubris::API::Gist
+
+  require_relative 'api/user'
+  include Githubris::API::User
+
   base_uri 'https://api.github.com'
   format :json
 
-  GISTS_PER_PAGE = 30
-  PUBLIC_GISTS_PATH = '/gists/public'
-
   def initialize
     @builder = Githubris::Builder.new
   end
@@ -15,30 +19,4 @@ class Githubris::API
   def authenticate!(options={})
     Githubris::API.basic_auth options[:login], options[:password]
   end
-
-  def get_public_gists(options={})
-    quantity = options.delete(:quantity) || 30
-    number_of_overflow_gists = quantity % GISTS_PER_PAGE
-    if quantity > GISTS_PER_PAGE
-      max_page_number = (quantity / GISTS_PER_PAGE) +
-        (number_of_overflow_gists > 0 ? 1 : 0)
-
-      data = Githubris::API.get public_gists_path_for_page(max_page_number)
-      gists = @builder.build(data).
-        concat(get_public_gists(quantity: quantity - GISTS_PER_PAGE))
-    else
-      url = PUBLIC_GISTS_PATH
-      data = Githubris::API.get(url)
-      gists = @builder.build(data)
-    end
-    gists.shift(quantity)
-  end
-
-  def get_user(options={})
-    Githubris::User.new
-  end
-
-  def public_gists_path_for_page page_number
-    "#{PUBLIC_GISTS_PATH}?page=#{page_number}"
-  end
 end

data/lib/githubris/builder/gist.rb

@@ -0,0 +1,16 @@
+class Githubris::Builder::Gist
+  def build data
+    gist_data = {}
+    gist_data[:id] = Integer(data.delete('id'))
+    gist_data[:public] = data.delete('public')
+    gist_data[:description] = data.delete('description')
+    gist_data[:files] = data.delete('files').values
+    gist_data[:url] = URI.parse data.delete('url')
+    gist_data[:created_at] = DateTime.parse data.delete('created_at')
+    gist_data[:updated_at] = DateTime.parse data.delete('updated_at')
+    tmp_arr = []
+    data.delete('comments').times { tmp_arr << Githubris::Comment.new }
+    gist_data[:comments] = tmp_arr
+    Githubris::Gist.new gist_data
+  end
+end

data/lib/githubris/builder/user.rb

@@ -0,0 +1,15 @@
+require 'githubris/builder'
+require 'githubris/user'
+
+class Githubris::Builder::User
+  def build data
+    user_attributes = {
+      :login => data.delete('login'),
+      :id => Integer(data.delete('id')),
+      :avatar_url => URI.parse(data.delete('avatar_url')),
+      :url => URI.parse(data.delete('url')),
+      :gravatar_id => data.delete('gravatar_id')
+    }
+    Githubris::User.new user_attributes
+  end
+end

data/lib/githubris/builder.rb

@@ -1,35 +1,15 @@
-class Githubris
-  class Builder
-    def build data
-      if data.instance_of? Array
-        build_gists data
-      else
-        build_gist data
-      end
-    end
-
-    def build_gists(data)
-      data.map do |gist|
-        build_gist gist
-      end
-    end
+class Githubris::Builder
+  autoload :Gist, 'githubris/builder/gist'
+  autoload :User, 'githubris/builder/user'
 
-    def build_gist(data)
-      data[:user] = build_user(data.delete 'user' )
-      data[:public] = data.delete('public')
-      data[:description] = data.delete('description')
-      data[:files] = data.delete('files').values
-      data[:url] = URI.parse data.delete('url')
-      data[:created_at] = DateTime.parse data.delete('created_at')
-      data[:updated_at] = DateTime.parse data.delete('updated_at')
-      tmp_arr = []
-      data.delete('comments').times { tmp_arr << Githubris::Comment.new }
-      data[:comments] = tmp_arr
-      Githubris::Gist.new data
+  def build_gists(data)
+    data = [data].flatten
+    data.map do |gist|
+      Githubris::Builder::Gist.new.build gist
     end
+  end
 
-    def build_user data
-      Githubris::User.new
-    end
+  def build_user(data)
+    Githubris::Builder::User.new.build(data)
   end
 end

data/lib/githubris/gist.rb

@@ -1,57 +1,68 @@
-class Githubris
-  class Gist
-    autoload :File, 'githubris/gist/file'
-
-    class << self
-      def default_options
-        {
-          files: [],
-          created_at: DateTime.now,
-          updated_at: DateTime.now
-        }
+class Githubris::Gist
+  autoload :File, 'githubris/gist/file'
+
+  def self.default_attributes
+    {
+      files: [],
+      created_at: DateTime.now,
+      updated_at: DateTime.now
+    }
+  end
+
+  def initialize attributes={}
+    attributes.merge! Githubris::Gist.default_attributes do |given_key, given_value|
+      if Githubris::Gist.default_attributes.has_key? given_key
+        given_value
       end
     end
 
-    def initialize options={}
-      options.merge! Githubris::Gist.default_options do |given_key, given_value|
-        if Githubris::Gist.default_options.has_key? given_key
-          given_value
-        end
-      end
+    @attributes = attributes
+  end
 
-      @options = options
-    end
+  def id
+    @attributes[:id]
+  end
 
-    def user
-      @options[:user]
-    end
+  def user
+    @attributes[:user]
+  end
 
-    def created_at
-      @options[:created_at]
-    end
+  def created_at
+    @attributes[:created_at]
+  end
 
-    def updated_at
-      @options[:updated_at]
-    end
+  def updated_at
+    @attributes[:updated_at]
+  end
 
-    def description
-      @options[:description]
-    end
+  def description
+    @attributes[:description]
+  end
 
-    def files
-      @options[:files]
-    end
+  def files
+    @attributes[:files]
+  end
 
-    def url
-      @options[:url]
-    end
+  def url
+    @attributes[:url]
+  end
 
-    def public?
-      @options[:public]
-    end
+  def public?
+    @attributes[:public]
+  end
 
-    def comments
-      @options[:comments]
-    end
+  def comments
+    @attributes[:comments]
+  end
+
+  def ==(other)
+    self.class == other.class &&
+      self.created_at == other.created_at &&
+      self.files == other.files &&
+      self.user == other.user
+  end
+
+  def set_attribute(attribute, value)
+    @attributes[attribute] = value
   end
 end

data/lib/githubris/user.rb

@@ -1,10 +1,36 @@
-class Githubris
-  class User
-    def initialize data={}
-    end
+class Githubris::User
+  def initialize attributes={}
+    @attributes = attributes
+  end
 
-    def public_gists
-    end
+  def public_gists
+    Githubris::API.new.get_user_public_gists(@attributes[:login])
+  end
+
+  def login
+    @attributes[:login]
+  end
+
+  def id
+    @attributes[:id]
+  end
 
+  def avatar_url
+    @attributes[:avatar_url]
+  end
+
+  def url
+    @attributes[:url]
+  end
+
+  def gravatar_id
+    @attributes[:gravatar_id]
+  end
+
+  def == other
+    other_attrs = other.instance_variable_get(:@attributes)
+    if other_attrs
+      @attributes == other_attrs
+    end
   end
 end

data/lib/githubris/version.rb

@@ -1,3 +1,3 @@
 class Githubris
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/githubris.rb

@@ -24,13 +24,13 @@ class Githubris
     @api = Githubris::API.new
   end
 
-  def authenticate(username, password)
-    @api.authenticate! login: username, password: password
+  def authenticate(login, password)
+    @api.authenticate! login: login, password: password
     @authenticated_user = Githubris::User.new
   end
 
   def find_user(login)
-    @api.get_user(login: login)
+    @api.get_user(login)
   end
 
   def public_gists(options={})

data/spec/githubris/api/gist_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Githubris::API::Gist do
+  subject do
+    Githubris::API.new
+  end
+
+  describe '#get_user_public_gists' do
+    let(:login) {'GithubrisTestUser'}
+
+    it 'gets /users/:username/gists' do
+      subject.stub(:user_gists_path => '/users/GithubrisTestUser/gists')
+      user_public_gists = subject.get_user_public_gists(login)
+      subject.should have_received(:user_gists_path).with(login)
+    end
+
+    it 'retrieves the full user' do
+      subject.stub(:get_user)
+      subject.get_public_gists(user: login)
+      subject.should have_received(:get_user).with(login)
+    end
+
+    context 'given a user with 2 gists' do
+      it 'returns 2 gists by the given user' do
+        user_public_gists = subject.get_public_gists(user: login)
+        user_public_gists.should have(2).items
+        user_public_gists.each do |gist|
+          gist.should be_instance_of Githubris::Gist
+        end
+      end
+    end
+
+  end
+
+  describe '#get_public_gists' do
+    it 'returns an array of gists' do
+      subject.get_public_gists.should be_instance_of Array
+      subject.get_public_gists.each do |gist|
+        gist.should be_instance_of Githubris::Gist
+      end
+    end
+
+    it 'accepts an options hash' do
+      lambda do
+        subject.get_public_gists({foo: 'bar'})
+      end.should_not raise_error
+    end
+
+    context 'given a page option' do
+      it 'returns an array of 30 gists from that page' do
+        page_one_gists = subject.get_public_gists(page: 1)
+        page_two_gists = subject.get_public_gists(page: 2)
+        page_one_gists.should have(30).items
+        page_two_gists.should have(30).items
+      end
+    end
+
+    context 'given a user option' do
+      it 'delegates to #get_user_public_gists' do
+        login = 'GithubrisTestUser'
+        subject.should_receive(:get_user_public_gists).with(login)
+        subject.get_public_gists(user: login)
+      end
+    end
+  end
+end

data/spec/githubris/api/user_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Githubris::API::User do
+  let(:api) { Githubris::API.new }
+
+  describe '#get_user' do
+    subject { api.get_user('login') }
+    it 'takes a login' do
+      lambda do
+        api.get_user('login')
+      end.should_not raise_error
+    end
+
+    it 'returns a user object' do
+      subject.should be_instance_of Githubris::User
+    end
+  end
+end

data/spec/githubris/api_spec.rb

@@ -1,28 +1,4 @@
 require 'spec_helper'
 
 describe Githubris::API do
-  describe '#get_public_gists' do
-    it 'returns an array of gists' do
-      subject.get_public_gists.should be_instance_of Array
-      subject.get_public_gists.each do |gist|
-        gist.should be_instance_of Githubris::Gist
-      end
-    end
-
-    it 'accepts an options hash' do
-      lambda do
-        subject.get_public_gists({foo: 'bar'})
-      end.should_not raise_error
-    end
-
-    context 'given a quantity option' do
-      it 'returns an array of gists with that quantity' do
-        subject.get_public_gists(quantity: 10).should have(10).items
-        subject.get_public_gists(quantity: 30).should have(30).items
-        subject.get_public_gists(quantity: 31).should have(31).items
-        subject.get_public_gists(quantity: 45).should have(45).items
-        subject.get_public_gists(quantity: 61).should have(61).items
-      end
-    end
-  end
 end

data/spec/githubris/builder/gist_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Githubris::Builder::Gist do
+  subject { Githubris::Builder::Gist.new.build gist_data }
+  let(:gist_data) { Githubris::SpecHelper.gist_data }
+
+  context 'schema' do
+
+    it                { should be_instance_of Githubris::Gist }
+    its(:url)         { should be_kind_of URI }
+    its(:id)          { should be_instance_of Fixnum }
+    its(:description) { should be_instance_of String }
+    it                { should be_public }
+    its(:created_at)  { should be_instance_of DateTime }
+    its(:updated_at)  { should be_instance_of DateTime }
+    its(:comments)    { should be_instance_of Array }
+    its(:files)       { should be_instance_of Array }
+  end
+
+  context 'when passed a specific gist' do
+
+    it 'is public' do
+      subject.should be_public
+    end
+
+    its(:id) { should eql 1 }
+
+    its(:description) { should eql 'the meaning of gist' }
+
+    it 'was created at 6:17:13 on July 15, 2008' do
+      subject.created_at.should eql DateTime.new(2008, 7, 15, 18, 17, 13)
+    end
+
+    it 'was updated at 2:58:22 on Feburary 22, 2011' do
+      subject.updated_at.should eql DateTime.new(2011, 2, 22, 2, 58, 22)
+    end
+  end
+end