cwsrb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e7e97678bb29181c0e9896d5c49784f1fda65a
-  data.tar.gz: cd4d7c60ed5ecc989707554c43cb46fc7096c590
+  metadata.gz: 1047b109cebaf37d125e16e499710bf0a5c9d82f
+  data.tar.gz: 757b7e9773d1dc27571e9d8f03f2bde6e828ddd6
 SHA512:
-  metadata.gz: 227da836fffb103857684c14537ec8b627ee184fb3188de541d83070533332512cdac1d0d193d3b2912a1b72ac8445e475e2d662c3cf6918adc9e993908605d4
-  data.tar.gz: 406a4beeb8b8716736c77d8efd3a5bdb77c81cba45a1a84535b00d3f914fb8d87f7c079ee15511809c713e4a05410e76ab6a6d577dc9999ccfc8ad2666a674a8
+  metadata.gz: 572100c7be00822e56d341babb109afa315c58d19b0066cedd859c0856e6abc55d6750656b1a1886cbbe3ff12a899ccbad086559d01733edff65b84c21750987
+  data.tar.gz: 0b1906d32dd4fb5511965c7950c2ec38b381323b8746dc39bc636fda928d8e445c03dfd2c8abade8860ce9202d5b07a4e25351ced5e30a044f868d59c8b02050

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.5.0
+* Added `#generate_link` to both `User` and `Language` that returns the corresponding CWS link to it.
+* Added a `karma` attribute to `Language` which represents the karma values for the language.
+* Updated documentation.
+
 ## 0.4.1
 * Fixed an error with the URIs not being encoded
 

data/lib/cwsrb/api.rb

@@ -22,7 +22,7 @@ module Cwsrb
     # 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
+    # @raise [APIError] If any error occurred while querying for that user
     def get_user(val)
       usr = URI.encode(Cwsrb::Helpers.resolve(val))
 
@@ -45,6 +45,10 @@ module Cwsrb
       Cwsrb::User.new(attribs)
     end
 
+    # Gets a ConWorkShop's language's info plus karma counts.
+    # @param val [String] The language's three-character code.
+    # @return [Language] The language queried for.
+    # @raise [APIError] If any error occurred while querying for that language
     def get_lang(val)
       val = URI.encode(val)
       response = self.class.get("/api/LANG/#{val}")
@@ -63,12 +67,17 @@ module Cwsrb
         public: response['PUBLIC'],
         status: get_lang_status(response['STATUS']),
         registered: Time.at(response['REGISTERED']),
-        word_count: response['WORD_COUNT']
+        word_count: response['WORD_COUNT'],
+        karma: response['KARMA']
       }
 
       Cwsrb::Language.new(attribs)
     end
 
+    # Translates a language type code to a Language::Type class.
+    # @param val [String] The one-character code.
+    # @return [Language::Type] The translated language type.
+    # @raise [APIError] If any error occurred while translating.
     def get_lang_type(val)
       val = URI.encode(val)
       response = self.class.get("/api/LANG/TYPE/#{val}")
@@ -84,6 +93,10 @@ module Cwsrb
       Cwsrb::Language::Type.new(attribs)
     end
 
+    # Translates a language status code to a Language::Status class.
+    # @param val [String] The one-character code.
+    # @return [Language::Status] The translated language status.
+    # @raise [APIError] If any error occurred while translating.
     def get_lang_status(val)
       val = URI.encode(val)
       response = self.class.get("/api/LANG/STATUS/#{val}")
@@ -99,6 +112,8 @@ module Cwsrb
       Cwsrb::Language::Status.new(attribs)
     end
 
+    # Gets the API version provided by the API.
+    # @return [String] The returned API version.
     def api_version
       self.class.get('/api')['api_ver']
     end

data/lib/cwsrb/data.rb

@@ -1,4 +1,6 @@
 module Cwsrb
+  CWS_BASE = 'http://conworkshop.com'
+
   # The User class represents a member of ConWorkShop.
   class User
     # @return [String, Integer] The User's ID
@@ -7,7 +9,8 @@ module Cwsrb
     # @return [String] The User's name
     attr_reader :name
 
-    # @return [String] The User's gender, one of "Male", "Female", "Cyborg" or "Other"
+    # @return [String] The User's gender, one of "Male", "Female", "Cyborg"
+    #   or "Other"
     attr_reader :gender
 
     # @return [String] The User's bio, max 1000 characters
@@ -16,18 +19,23 @@ module Cwsrb
     # @return [String] The User's country
     attr_reader :country
 
-    # @return [Array<(Integer, Integer)>] The User's karma counts; first one is upvotes and second one is downvotes
+    # @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 id [String, Integer] The user's ID: a bunch of numbers that may
+    #   or may not be prefixed with 'S'. Defaults to an empty string.
+    # @param name [String] The user's name. Defaults to an empty string.
+    # @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 [User] a new instance of `User`
-    def initialize(id: nil, name: nil, gender: 'Other', bio: '', country: 'Unknown', karma: [0, 0])
+    # @param karma [Array<(Integer, Integer)>] The user's karma counts.
+    #   First is upvotes, second is downvotes. Defaults to zero for both.
+    # @return [User] a new instance of User
+    def initialize(id: '', name: '', gender: 'Other', bio: '', country: 'Unknown', karma: [0, 0])
       @id = id
       @name = name
       @gender = gender
@@ -36,57 +44,140 @@ module Cwsrb
       @karma = karma
     end
 
+    # Generates a CWS link to this user.
+    # @return [String] The generated link.
+    def generate_link
+      CWS_BASE + "/view_profile.php?m=#{@id}"
+    end
+
     # @overload inspect
-    #   @return [String] A more meaningful output than that of the default inspect method, with all of User's attributes.
+    #   @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
 
+  # The Language class represents a language of ConWorkShop.
   class Language
+    # The Type class represents a language type of ConWorkShop.
     class Type
+      # @return [String] The three-character type code.
       attr_reader :code
+
+      # @return [String] The description for the type.
       attr_reader :desc
 
-      def initialize(code: nil, desc: '')
+      # Initializes a new Type instance with an options hash.
+      # @param code [String] The three-character type code. Defaults to an
+      #   empty string.
+      # @param desc [String] The description for the type. Defaults to an
+      #   empty string.
+      # @return [Type] A new instance of Type.
+      def initialize(code: '', desc: '')
         @code = code
         @desc = desc
       end
 
+      # @overload inspect
+      #   @return [String] A more meaningful output than that of the default
+      #   inspect method, with all of Type's attributes.
       def inspect
         "<Language::Type code=#{@code} desc=#{@desc}>"
       end
     end
 
+    # The Language::Type class represents a language status of ConWorkShop.
     class Status
+      # @return [String] The one-character status code.
       attr_reader :code
+
+      # @return [String] The description for the status.
       attr_reader :desc
 
-      def initialize(code: nil, desc: '')
+      # Initializes a new Status instance with an options hash.
+      # @param code [String] The one-character status code. Defaults to an
+      #   empty string.
+      # @param desc [String] The description for the status. Defaults to an
+      #   empty string.
+      def initialize(code: '', desc: '')
         @code = code
         @desc = desc
       end
 
+      # @overload inspect
+      #   @return [String] A more meaningful output than that of the default
+      #   inspect method, with all of Status' attributes.
       def inspect
         "<Language::Status code=#{@code} desc=#{@desc}>"
       end
     end
 
+    # @return [String] The three-character language code.
     attr_reader :code
+
+    # @return [String] The language's name.
     attr_reader :name
+
+    # @return [String] The language's autonym (native name).
     attr_reader :native_name
+
+    # @return [String] The IPA transcription for the language's {@link native_name}
     attr_reader :ipa
+
+    # @return [Language::Type] The language's type.
     attr_reader :type
+
+    # @return [Array<String>] The owner plus shared users of this language.
+    #   The first element is the original owner.
     attr_reader :owners
+
+    # @return [String] The overview, about section or bio, of this language.
     attr_reader :overview
+
+    # @return [Boolean] Whether or not this language's _dictionary_ is public.
     attr_reader :public
+
+    # @return [Language::Status] The language's status.
     attr_reader :status
+
+    # @return [Time] The time at which the language was registered.
     attr_reader :registered
+
+    # @return [Integer] The word count for this language.
     attr_reader :word_count
 
-    def initialize(code: nil, name: nil, native_name: nil, ipa: nil, type: nil,
+    # @return [Array<(Integer, Integer)>] The language's karma counts;
+    #   first one is upvotes and second one is downvotes.
+    attr_reader :karma
+
+    # Initializes a new Language instance with an options hash.
+    # @param code [String] The three-character language code. Defaults to an
+    #   empty string.
+    # @param name [String] The language's name. Defaults to an empty string.
+    # @param native_name [String] The language's autonym (native name).
+    #   Defaults to an empty string.
+    # @param ipa [String] The IPA transcription for the autonym. Defaults to
+    #   an empty string.
+    # @param type [Type] The language's type. Defaults to `nil`.
+    # @param owners [Array<String>] The owner plus shared users of this
+    #   language. The first element must be the original owner.
+    # @param overview [String] The overview, about me section, or bio, of
+    #   this language. Defaults to an empty string.
+    # @param public [Boolean] Whether or not this language's dictionary is
+    #   public. Defaults to `true`.
+    # @param status [Status] The language's status. Defaults to `nil`.
+    # @param registered [Time] When the language was registered. Defaults to
+    #   the current time.
+    # @param word_count [Integer] The amount of words this language has.
+    #   Defaults to `0`.
+    # @param karma [Array<(Integer, Integer)>] The language's karma counts.
+    #   The first is upvotes, the second is downvotes. Defaults to zero for
+    #   both.
+    # @return [Language] The new Language instance.
+    def initialize(code: '', name: '', native_name: '', ipa: '', type: nil,
                    owners: [], overview: '', public: true, status: '',
-                   registered: Time.now, word_count: 0)
+                   registered: Time.now, word_count: 0, karma: [0, 0])
       @code = code
       @name = name
       @native_name = native_name
@@ -98,13 +189,23 @@ module Cwsrb
       @status = status
       @registered = registered
       @word_count = word_count
+      @karma = karma
     end
 
+    # Generates a CWS link to this language.
+    # @return [String] The generated link.
+    def generate_link
+      CWS_BASE + "/view_language.php?l=#{@code}"
+    end
+
+    # @overload inspect
+    #   @return [String] A more meaningful output than that of the default
+    #   inspect method, with all of Language's attributes.
     def inspect
       "<Language code=#{@code} name=#{@name} native_name=#{@native_name} " \
         "ipa=#{@ipa} type=#{@type} owners=#{@owners} overview=#{@overview} " \
         "public=#{@public} status=#{@status} registered=#{@registered} " \
-        "word_count=#{@word_count}>"
+        "word_count=#{@word_count} karma=#{@karma}>"
     end
   end
 end

data/lib/cwsrb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cwsrb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Unleashy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Access Conworkshop's API with Ruby.