coder_wally 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce08332a669f0fab248e145033366fab6f89a89
-  data.tar.gz: b4cc4a66611195652695244724152dfddbfc45c8
+  metadata.gz: 84448d05d51d8fedf698a7bdf9163c7fdc450db6
+  data.tar.gz: 241c66da1f41c0c09403c4d6ef809525a28e0a2c
 SHA512:
-  metadata.gz: 6837d0ad987b1689ec808bdea5f1a076b633d253bc72246d87fe5ef51dcdcb27ab49b174c71adc00b247c61dda9ab55dc1c12b6430758c512faa677c70527882
-  data.tar.gz: c17ddb445161f3c4bce8b491a6f8ea7e9d46ddd1a6038ca37da31bcf5c13cb406c85239b5af35945305f0e8afd1237f43190cc68bcc9d292ba5a528e9e0ff2f6
+  metadata.gz: da39a27e989de4e8b652da155a028bc50e9796166ba0396496c1bc6076f0bdfe080245bbad174b3a4c663742830bbb8cef834346567f09557aa67594f500f4e2
+  data.tar.gz: eec5c75161b05440442b05c335e756c691b4e395badd2edce5b81261d6468f4aee0fe6815306c149c363b58abcc70368bf9da5bed0dbb2f29090f7977dd4437e

data/bin/coder_wally

@@ -2,7 +2,6 @@
 
 require 'coder_wally'
 
-client = CoderWally::Client.new
-coder_wally = client.get_everything_for ARGV[0]
+client = CoderWally::Client.new ARGV[0]
 
-puts coder_wally.inspect
+puts client.user.inspect

data/coder_wally.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'webmock', '~>1.20.4'
-  spec.add_development_dependency 'coveralls', '~>0.7.9'
-  spec.add_development_dependency 'rubocop', '~>0.29.0'
+  spec.add_development_dependency 'bundler', '~> 1.7.12'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'webmock', '~>1.21.0'
+  spec.add_development_dependency 'coveralls', '~>0.8.0'
+  spec.add_development_dependency 'rubocop', '~>0.29.1'
 end

data/lib/coder_wally/builder.rb

@@ -22,16 +22,16 @@ module CoderWally
 
     # parse user information from data
     def parse_user(data)
-      User.new(data)
+      badges = parse_badges(data['badges'])
+      accounts = parse_accounts(data['accounts'])
+      User.new(data, badges, accounts)
     end
 
     # build CoderWall object from API response
     def build(response)
-      badges = parse_badges(response['badges'])
-      accounts = parse_accounts(response['accounts'])
       user = parse_user(response)
 
-      CoderWall.new badges, user, accounts
+      CoderWall.new user
     end
   end
 end

data/lib/coder_wally/client.rb

@@ -2,34 +2,50 @@ module CoderWally
   # Client to access the API
   class Client
     # Instantiate class
-    def initialize
+    def initialize(username)
       @api = API.new
       @builder = Builder.new
+      @coder_wall = build_coder_wall_from_response(username)
     end
 
     # Get badges for given user and return has collection of `Badge`s
-    def get_badges_for(username)
-      coder_wall = build_coder_wall_from_response(username)
-      coder_wall.badges
+    def get_badges_for(*username)
+      deprecation_message("get_badges_for(#{username})",'user.badges')
+      @coder_wall.user.badges
     end
 
     # Get user details for given user and return a `User` object
-    def get_details_for(username)
-      coder_wall = build_coder_wall_from_response(username)
-      coder_wall.user
+    def get_details_for(*username)
+      deprecation_message("get_details_for(#{username})",'user.details')
+      @coder_wall.user.details
     end
 
     # Get all the information available for a given user,
     # returns a `CoderWall` object
-    def get_everything_for(username)
-      build_coder_wall_from_response(username)
+    def get_everything_for(*username)
+      deprecation_message("get_everything_for(#{username})",'user')
+      @coder_wall
     end
 
+    # Get all the information for a given user
+    # Returns a user object
+    def user
+      @coder_wall.user
+    end
+
+    private
+
     # Builds a CoderWall object
     def build_coder_wall_from_response(username)
       json_response = @api.fetch(username)
 
       @builder.build(json_response)
     end
+
+    # displaying a warning message that the API method is deprecated
+    def deprecation_message(old, new)
+      warn "[DEPRECATION] `#{old}` is deprecated.  Please use `#{new}` instead."
+    end
+
   end
 end

data/lib/coder_wally/coder_wall.rb

@@ -3,15 +3,15 @@ module CoderWally
   # Stores all CoderWall attributes
   class CoderWall
     # :badges is the collection of user badges
-    # :user is the `User` object
+    # :user is the `User` object (with badges and accounts)
     # :accounts is the `Account` object
     attr_reader :badges, :user, :accounts
 
     # Instantiate the class with data
-    def initialize(badges, user, accounts)
-      @badges = badges
+    def initialize(user)
       @user = user
-      @accounts = accounts
+      @badges = user.badges
+      @accounts = user.accounts
     end
   end
 end

data/lib/coder_wally/user.rb

@@ -3,15 +3,19 @@ module CoderWally
   # Stores user properties
   class User
     # Object properties
-    attr_reader :name, :username, :location, :team, :endorsements
+    attr_reader :badges, :accounts, :details
 
     # Initialise object with a hash of values
-    def initialize(data)
-      @name = data['name']
-      @username = data['username']
-      @location = data['location']
-      @team = data['team']
-      @endorsements = data['endorsements']
+    def initialize(data, badges, accounts)
+      @badges = badges
+      @accounts = accounts
+      @details = {
+          name: data['name'],
+          username: data['username'],
+          location: data['location'],
+          team: data['team'],
+          endorsements: data['endorsements']
+      }
     end
   end
 end

data/lib/coder_wally/version.rb

@@ -1,5 +1,5 @@
 # All code in the gem is namespaced under this module.
 module CoderWally
   # The current version of CoderWally.
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/test/coder_wally_test.rb

@@ -3,7 +3,6 @@ require 'coder_wally'
 
 describe 'Coder Wally' do
   before do
-    @client = CoderWally::Client.new
     @accept_encoding = 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'
     @success_fixture = File.dirname(__FILE__) + '/./fixtures/200.json'
   end
@@ -17,6 +16,7 @@ describe 'Coder Wally' do
                            'Accept-Encoding' => @accept_encoding,
                            'User-Agent' => 'Ruby' })
           .to_return(status: 200, body:  success_response, headers: {})
+        @client = CoderWally::Client.new('me')
       end
 
       it 'returns a hash of badges' do
@@ -32,12 +32,12 @@ describe 'Coder Wally' do
 
     describe 'invalid user' do
       it 'throws an exception when no user is passed in' do
-        err = -> { @client.get_badges_for }.must_raise ArgumentError
+        err = -> { CoderWally::Client.new() }.must_raise ArgumentError
         err.message.must_match(/wrong number/)
       end
 
       it 'throws an exception when empty string is passed in' do
-        err = -> { @client.get_badges_for '' }.must_raise ArgumentError
+        err = -> { CoderWally::Client.new('') }.must_raise ArgumentError
         err.message.must_match(/Please provide a username/)
       end
 
@@ -53,7 +53,7 @@ describe 'Coder Wally' do
         end
 
         it 'throws a UserNotFoundError when the user is not found' do
-          err = -> { @client.get_badges_for('me') }.must_raise UserNotFoundError
+          err = -> { CoderWally::Client.new('me') }.must_raise UserNotFoundError
           err.message.must_match(/User not found/)
         end
       end
@@ -71,7 +71,7 @@ describe 'Coder Wally' do
       end
 
       it 'throws a ServerError when the server response is 500' do
-        err = -> { @client.get_badges_for('me') }.must_raise ServerError
+        err = -> { CoderWally::Client.new('me') }.must_raise ServerError
         err.message.must_match(/Server error/)
       end
     end
@@ -88,7 +88,7 @@ describe 'Coder Wally' do
       end
 
       it 'throws a InvalidJson exception when bad JSON is returned' do
-        err = -> { @client.get_badges_for('me') }.must_raise InvalidJson
+        err = -> { CoderWally::Client.new('me') }.must_raise InvalidJson
         err.message.must_match(/invalid json/)
       end
     end
@@ -102,16 +102,16 @@ describe 'Coder Wally' do
                          'Accept-Encoding' => @accept_encoding,
                          'User-Agent' => 'Ruby' })
         .to_return(status: 200, body:  success_response, headers: {})
+      @client = CoderWally::Client.new('me')
     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_be_nil
-      user.endorsements.must_be_kind_of Integer
+      user[:name].must_equal 'Greg Stewart'
+      user[:username].must_equal 'gregstewart'
+      user[:location].must_equal 'London, UK'
+      user[:team].must_be_nil
+      user[:endorsements].must_be_kind_of Integer
     end
   end
 
@@ -124,6 +124,7 @@ describe 'Coder Wally' do
                          'User-Agent' => 'Ruby' })
         .to_return(status: 200, body:  success_response, headers: {})
 
+      @client = CoderWally::Client.new('me')
       @coder_wall = @client.get_everything_for('me')
     end
 
@@ -144,4 +145,42 @@ describe 'Coder Wally' do
       @coder_wall.accounts.must_be_instance_of CoderWally::Account
     end
   end
+
+  describe 'client' do
+    before do
+      success_response = open(File.expand_path(@success_fixture)).read
+      stub_request(:get, 'https://coderwall.com/me.json')
+          .with(headers: { 'Accept' => '*/*',
+                           'Accept-Encoding' => @accept_encoding,
+                           'User-Agent' => 'Ruby' })
+          .to_return(status: 200, body:  success_response, headers: {})
+
+      @client = CoderWally::Client.new('me')
+    end
+
+    it 'exposes a user object' do
+      @client.user.must_be_instance_of CoderWally::User
+    end
+
+    describe 'user' do
+      it 'has a badges collection' do
+        @client.user.badges.count.must_equal 11
+        @client.user.badges.first.must_be_instance_of CoderWally::Badge
+      end
+
+      it 'has an accounts property' do
+        @client.user.accounts.must_be_instance_of CoderWally::Account
+      end
+
+      it 'returns a users details' do
+        details = @client.user.details
+
+        details[:name].must_equal 'Greg Stewart'
+        details[:username].must_equal 'gregstewart'
+        details[:location].must_equal 'London, UK'
+        details[:team].must_be_nil
+        details[:endorsements].must_be_kind_of Integer
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coder_wally
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Greg Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.12
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: 1.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.9
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.9
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.29.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.29.1
 description: A simple gem to fetch user badges from Coder Wall
 email:
 - gregs@tcias.co.uk