cwsrb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a9819ae04560d78506287cd52a93a95c4309a20
-  data.tar.gz: fceb3bbf0edcf501d2ccff0540c962895d86d411
+  metadata.gz: 3f5f7a7480e1233b3cc3043f175298be9e970bfd
+  data.tar.gz: d04fc19a79bd91e0b54883eff1407998ea592b11
 SHA512:
-  metadata.gz: 0f91cbacc3f81efa121e75ea643edd591fdd339ba73720ec8664d07384134c94cc00f9e9155ff944682b5ad1d13a5c7e62583518bac1fd20d8526b2281abb1ac
-  data.tar.gz: 852b4c8b3b989a134e55b97ab31f962135afcfa9ceb7cc7bc5aa3ab2cea816ec067a2763e0a594470caad5e550d27d7c37e9273323a2ebb7b5ba6e31e60d96b1
+  metadata.gz: f74e5d1623a70bde7e8f200bd333a34fe2d079a3ced37542f80312621c1cda33f4c4ddc03640cabcbd5c2aa9005c29f690fdbe25e2eb2d2834aa45fdeb2fc012
+  data.tar.gz: 73a7540d911305e901dc865d4e77ac43c2d09a6475368347c3dfd66c8fe0b4d94be30c5fdc6bd4c2b39f0b212fc138d5dfe914da80d6898eb68ab19f7b678bf9

data/.rubocop.yml

@@ -1,11 +1,35 @@
+# no metrics
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
 Metrics/LineLength:
-  Max: 120
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
 
-# TODO: documentation (I SWEAR I'LL DO IT SOMEDAY)
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/cwsrb.rb'
-    - 'lib/cwsrb/api.rb'
-    - 'lib/cwsrb/helpers.rb'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.3.0
+* Documented everything I could with YARD. yay! ([#2](https://github.com/unleashy/cwsrb/issues/2))
+* Added `User` class that is returned for calls to `API#get_user`. ([#3](https://github.com/unleashy/cwsrb/issues/3))
+* `Helpers#resolve` would return an @-prefixed string if you gave it an `Integer`. Well, no more! ([#1](https://github.com/unleashy/cwsrb/issues/1))
+* Merged `API#get_karma` into `API#get_user`
+* Made it so the testing console already initialized an API object for you
+* Disabled metrics for rubocop
+
+## 0.2.0
+* First release on GitHub
+
+## 0.1.0
+* First actual release

data/README.md

@@ -1,6 +1,9 @@
-# Cwsrb
+[![Gem](https://img.shields.io/gem/v/cwsrb.svg)](https://rubygems.org/gems/cwsrb)
+[![Build Status](https://travis-ci.org/unleashy/cwsrb.svg?branch=master)](https://travis-ci.org/unleashy/cwsrb)
 
-Cwsrb is a simple API wrapper for [ConWorkShop](http://conworkshop.com).
+# CWSrb
+
+CWSrb is a simple API wrapper for [ConWorkShop](http://conworkshop.com).
 
 ## Dependencies
 
@@ -8,11 +11,24 @@ Cwsrb is a simple API wrapper for [ConWorkShop](http://conworkshop.com).
 
 ## Installation
 
-Check the [Development section](https://github.com/unleashy/cwsrb#development). I'll probably put this in [rubygems.org](https://rubygems.org) later.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cwsrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cwsrb
 
 ## Usage
 
-... TODO ...
+TODO
+(I swear I'll fill this out)
 
 ## Development
 

data/bin/console

@@ -3,5 +3,9 @@
 require 'bundler/setup'
 require 'cwsrb'
 
+# Set up API object
+api = Cwsrb::API.new('CWSrb Testing Console')
+puts 'The Cwsrb::API object was initialized to the `api` variable.'
+
 require 'irb'
 IRB.start

data/lib/cwsrb.rb

@@ -1,7 +1,9 @@
 require 'cwsrb/version'
 require 'cwsrb/errors'
 require 'cwsrb/helpers'
+require 'cwsrb/user'
 require 'cwsrb/api'
 
+# This module is the main 'namespace' for CWSrb, and is extended in all other CWSrb files.
 module Cwsrb
 end

data/lib/cwsrb/api.rb

@@ -1,36 +1,56 @@
 require 'httparty'
 require 'cwsrb/errors'
 require 'cwsrb/helpers'
+require 'cwsrb/user'
 
 module Cwsrb
+  # This is the main class from which you use CWSrb.
+  # It includes `HTTParty` with a `base_uri` of "http://conworkshop.com".
   class API
     include HTTParty
     base_uri 'http://conworkshop.com'
 
+    # Initialize a new instance of the API object, with a mandatory custom User-Agent for HTTP requests.
+    # This sets the User-Agent header for all subsequent requests, with your custom User-Agent and CWSrb's User-Agent.
+    # @param user_agent [String] The User-Agent to use with HTTP requests. Please use a descriptive one.
+    # @return [void] _dust_
     def initialize(user_agent)
       self.class.headers 'User-Agent' =>
                              "#{user_agent} CWSrb/#{Cwsrb::VERSION} (#{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL})"
     end
 
-    def get_karma(val)
-      # Determine if val is an ID or username.
+    # Gets a ConWorkShop's user's info plus karma counts.
+    # @param val [String, Integer] The user's name or ID.
+    # @return [User] The user queried for
+    # @raise [APIError] If any error ocurred while querying for that user
+    def get_user(val)
       usr = Cwsrb::Helpers.resolve(val)
-      response = self.class.get("/api?f=USER_KARMA&USER=#{usr}")
+
+      # First general info
+      response = self.class.get("/api?f=USER&USER=#{usr}")
 
       # Check if any errors occurred
       Cwsrb::Helpers.check_for_errors(response)
 
-      response['out']
-    end
+      response = response['out']
+      attribs = {
+        id: response['USER_ID'],
+        name: response['USER_NAME'],
+        gender: response['USER_GENDER'],
+        bio: response['USER_BIO'],
+        country: response['USER_COUNTRY']
+      }
 
-    def get_user(val)
-      usr = Cwsrb::Helpers.resolve(val)
-      response = self.class.get("/api?f=USER&USER=#{usr}")
+      # Now karma
+      response = self.class.get("/api?f=USER_KARMA&USER=#{usr}")
 
       # Check if any errors occurred
       Cwsrb::Helpers.check_for_errors(response)
 
-      response['out']
+      response = response['out']
+      attribs[:karma] = [response['KARMA_UP'], response['KARMA_DOWN']]
+
+      Cwsrb::User.new(attribs)
     end
   end
 end

data/lib/cwsrb/errors.rb

@@ -1,4 +1,12 @@
 module Cwsrb
+  # @!group Errors
+
+  # @abstract This class subclasses `RuntimeError` and serves as a base
+  #   for all other CWSrb's error classes.
   Error = Class.new(RuntimeError)
+
+  # Raised when a general APIError occurs.
   APIError = Class.new(Error)
+
+  # @!endgroup
 end

data/lib/cwsrb/helpers.rb

@@ -1,14 +1,23 @@
 module Cwsrb
+  # This module has a bunch of utility functions for use in other files.
+  # All methods are marked as `module_function` so you can do things like `Helpers.resolve`.
   module Helpers
     module_function
 
+    # Determine if val is an ID or username.
+    # ID is a bunch of numbers that can or cannot be followed by an 'S'.
+    # Username... is not an ID.
+    # @param val [String, Integer] The value to discriminate
+    # @return [String, Integer] Either an '@'-prefixed `val` if it's an username or val itself if it isn't
     def resolve(val)
-      # Determine if val is an ID or username.
-      # ID is a bunch of numbers that can or cannot be followed by an 'S'.
-      # Username... is not an ID.
+      return val if val.is_a?(Integer)
       (val =~ /\A(S?\d+)\z/) ? val : "@#{val}"
     end
 
+    # Verifies if the response has any errors, and if so, raises a `APIError`.
+    # @param response [Hash<String, String>] the response hash to check for errors
+    # @raise [APIError] if any errors are detected in the response
+    # @return [void] _dust_
     def check_for_errors(response)
       raise Cwsrb::APIError, response['err_msg'] if response['err_idx'] > 0
     end

data/lib/cwsrb/user.rb

@@ -0,0 +1,51 @@
+module Cwsrb
+  # The User class represents an member of ConWorkShop.
+  class User
+    # @!attribute [r] id
+    #   @return [String, Integer] The User's ID
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] The User's name
+    attr_reader :name
+
+    # @!attribute [r] gender
+    #   @return [String] The User's gender, one of "Male", "Female", "Cyborg" or "Other"
+    attr_reader :gender
+
+    # @!attribute [r] bio
+    #   @return [String] The User's bio, max 1000 characters
+    attr_reader :bio
+
+    # @!attribute [r] country
+    #   @return [String] The User's country
+    attr_reader :country
+
+    # @!attribute [r] karma
+    #   @return [Array<(Integer, Integer)>] The User's karma counts. First one is upvotes and second one is downvotes.
+    attr_reader :karma
+
+    # Initializes a new User instance with an options hash.
+    # @param id [String, Integer] The user's ID: a bunch of numbers that may or may not be prefixed with 'S'.
+    # @param name [String] The user's name. Defaults to `nil`.
+    # @param gender [String] The user's gender, one of "Male", "Female", "Cyborg" or "Other". Defaults to "Other".
+    # @param bio [String] The user's bio or about section. Defaults to an empty string.
+    # @param country [String] The user's country. Defaults to "Unknown".
+    # @param karma [Array<(Integer, Integer)>] The user's karma counts (first is upvotes, second is downvotes). Defaults to zero for both.
+    # @return [void] _dust_
+    def initialize(id: nil, name: nil, gender: 'Other', bio: '', country: 'Unknown', karma: [0, 0])
+      @id = id
+      @name = name
+      @gender = gender
+      @bio = bio
+      @country = country
+      @karma = karma
+    end
+
+    # @overload inspect
+    #   @return [String] A more meaningful output than that of the default inspect method, with all of User's attributes.
+    def inspect
+      "<User id=#{@id} name=#{@name} gender=#{gender} bio=#{bio} country=#{country} karma=#{karma}>"
+    end
+  end
+end

data/lib/cwsrb/version.rb

@@ -1,3 +1,4 @@
 module Cwsrb
-  VERSION = '0.2.0'.freeze
+  # The current version of CWSrb.
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cwsrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Unleashy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-11 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -91,6 +91,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -103,6 +105,7 @@ files:
 - lib/cwsrb/api.rb
 - lib/cwsrb/errors.rb
 - lib/cwsrb/helpers.rb
+- lib/cwsrb/user.rb
 - lib/cwsrb/version.rb
 homepage: https://github.com/unleashy/cwsrb
 licenses: