coder_wally 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c19b110b50c0f07411b0d0400449649565e2975
-  data.tar.gz: 18e744906436350a32deac74aaccf3bccf233a7e
+  metadata.gz: de7d714b9060a7341d0c9d2d296952014aae00f0
+  data.tar.gz: 2a4f6c6966cf91dd7c6102778cadf674d75d93e0
 SHA512:
-  metadata.gz: f11d10151bceca3d68de3a447149bb2b49df0ec988493ee417560771c6236ec43a1084b2fec7ab1e7bc48c1ba2c448baf765e01a341768a40e49f1370c3c80c8
-  data.tar.gz: 6ecf02798f6e642b6cbaf3ab20446e0a9127be3aa5d5974af6c4fab93f9c72a90d06cb3fceb4ccc3d64048fd055476f13e60a020be49ae2e82bb74073cb6ef38
+  metadata.gz: 8343ae8cbf488bfa7a5657ea6fe78752912c1dd1fead2b3ffbad1b156a9694f1addda68cf78307b83cbc33309a277e999fee823a9b3f33affe19f58becf03384
+  data.tar.gz: dfad37a1cd31aa8545307515e12b5741a917f6176973c73d00a575d3a8c1179eeaab0ec14709fe9db9adb0c73633666da2c72d5d0d9b9303296ee66b5b6b6309

data/README.md

@@ -33,11 +33,16 @@ using:
 
     ruby -Ilib bin/coder_wally <username>
 
-In your code:
+In order to get a user's badges, you do this:
 
     client = CoderWally::Client.new
     client.get_badges_for <username>
 
+In order to get a user's details, you do this:
+
+    client = CoderWally::Client.new
+    client.get_details_for <username>
+
 ## Contributing
 
 1. Fork it ( https://github.com/gregstewart/coder_wally/fork )

data/lib/coder_wally/badge.rb

@@ -1,5 +1,6 @@
 # All code in the gem is namespaced under this module.
 module CoderWally
+    # Stores Badge properties
     class Badge 
         # Object properties 
         attr_reader :name, :badge, :description, :created

data/lib/coder_wally/client.rb

@@ -2,13 +2,16 @@ require "open-uri"
 require "json"
 
 module CoderWally
+    # Client to access the API
     class Client
-         # The URL of API we'll use.
+         # The URL of the API we'll use.
         def api_url
           "https://coderwall.com/%s.json"
         end
         # Build user URI from username and apii url
         def uri_for_user username
+          raise(ArgumentError, "Plesae provide a username") if username.empty?
+          
           URI.parse(api_url % username)
         end
         # Dispatch the request
@@ -20,19 +23,27 @@ module CoderWally
             raise ServerError, "Server error" if  error.io.status[0] == "500"
           end
         end
-        # Get bnadges for given user and return has of `Badge`s
+        # Get badges for given user and return has collection of `Badge`s
         def get_badges_for username
-          raise(ArgumentError, "Plesae provide a username") if username.empty?
-          
           json_response = JSON.load(send_request(uri_for_user(username)))      
           
           json_response["badges"].map { |badge| Badge.new(badge) }
         end
+        
+        # Get user details for given user and return a `User` object
+        def get_details_for username
+          json_response = JSON.load(send_request(uri_for_user(username)))      
+        
+          User.new(json_response["name"], json_response["username"],
+            json_response["location"], json_response["team"])
+        end
     end
 end
 
+# Handles user not found exception
 class UserNotFoundError < StandardError
 end
 
+# Handles server exception
 class ServerError < StandardError
-end
+end

data/lib/coder_wally/user.rb

@@ -0,0 +1,16 @@
+# All code in the gem is namespaced under this module.
+module CoderWally
+    # Stores user properties
+    class User 
+        # Object properties 
+        attr_reader :name, :username, :location, :team
+        
+        # Initialise object with a hash of values
+        def initialize(name, username, location, team)
+          @name = name
+          @username = username
+          @location = location 
+          @team = team
+        end
+    end
+end

data/lib/coder_wally/version.rb

@@ -1,4 +1,4 @@
 module CoderWally
-  # The current version of HowIStart.
-  VERSION = "0.0.4"
+  # The current version of CoderWally.
+  VERSION = "0.0.5"
 end

data/lib/coder_wally.rb

@@ -1,3 +1,4 @@
 require "coder_wally/version"
 require "coder_wally/badge"
+require "coder_wally/user"
 require "coder_wally/client"

data/test/coder_wally_test.rb

@@ -70,4 +70,23 @@ describe "Coder Wally" do
         end
       end
   end
+  
+  describe "user details" do
+    before do
+      success_response = open(File.expand_path(File.dirname(__FILE__) + "/./fixtures/200.json")).read
+      stub_request(:get, "https://coderwall.com/me.json").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => success_response, :headers => {})
+    end
+    
+    it "returns a user" do
+        user = @client.get_details_for('me')
+        
+        user.name.must_equal "Greg Stewart"
+        user.username.must_equal "gregstewart"
+        user.location.must_equal "London, UK"
+        user.team.must_equal nil
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coder_wally
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Greg Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - lib/coder_wally.rb
 - lib/coder_wally/badge.rb
 - lib/coder_wally/client.rb
+- lib/coder_wally/user.rb
 - lib/coder_wally/version.rb
 - test/coder_wally_test.rb
 - test/fixtures/200.json