cwsrb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f5f7a7480e1233b3cc3043f175298be9e970bfd
-  data.tar.gz: d04fc19a79bd91e0b54883eff1407998ea592b11
+  metadata.gz: 4246d4926b2154bc2831dcd3ba29358522c1e91c
+  data.tar.gz: db76f712ee09ee8efd4351c86a8873dff4f1fb44
 SHA512:
-  metadata.gz: f74e5d1623a70bde7e8f200bd333a34fe2d079a3ced37542f80312621c1cda33f4c4ddc03640cabcbd5c2aa9005c29f690fdbe25e2eb2d2834aa45fdeb2fc012
-  data.tar.gz: 73a7540d911305e901dc865d4e77ac43c2d09a6475368347c3dfd66c8fe0b4d94be30c5fdc6bd4c2b39f0b212fc138d5dfe914da80d6898eb68ab19f7b678bf9
+  metadata.gz: 1dfd4cd995f8729ea36f3378617379a6deb35a6a9d1f694641e98869e7814b08c5fe5f82b32ebc2685339d2b748a2e3bb5792a637c01d251c0a935d58ff320b5
+  data.tar.gz: fb66323f08d65b0deab1a1b056ef9e0a5078f3348103828aedb96c02ed4de7a1ebe22dbfae3e71ab3b8a1b9844fad402b46f309e7e9770474ee79eb5a89b365b

data/.rubocop.yml

@@ -1,35 +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:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-
-AllCops:
-  Exclude:
-    - 'bin/**/*'
+# no metrics
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.4.0
+* Add new `Language` class and related subclasses `Type` and `Status` that are returned for calls to `API#get_lang`,
+  `API#get_lang_type` and `API#get_lang_status`, respectively
+* Add new `API#api_version` to get the API version returned by CWS
+* Since the API now merged the functions `USER` and `USER_KARMA`, it is reflected in CWSrb correctly now
+* **TODO**: documentation for the classes above
+
 ## 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))

data/README.md

@@ -1,5 +1,6 @@
 [![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)
+[![Inline docs](http://inch-ci.org/github/unleashy/cwsrb.svg?branch=master)](http://inch-ci.org/github/unleashy/cwsrb)
 
 # CWSrb
 

data/lib/cwsrb.rb

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

data/lib/cwsrb/api.rb

@@ -1,19 +1,19 @@
 require 'httparty'
 require 'cwsrb/errors'
 require 'cwsrb/helpers'
-require 'cwsrb/user'
+require 'cwsrb/data'
 
 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'
+    base_uri '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_
+    # @return [API] a new instance of `API`
     def initialize(user_agent)
       self.class.headers 'User-Agent' =>
                              "#{user_agent} CWSrb/#{Cwsrb::VERSION} (#{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL})"
@@ -27,7 +27,7 @@ module Cwsrb
       usr = Cwsrb::Helpers.resolve(val)
 
       # First general info
-      response = self.class.get("/api?f=USER&USER=#{usr}")
+      response = self.class.get("/api/USER/#{usr}")
 
       # Check if any errors occurred
       Cwsrb::Helpers.check_for_errors(response)
@@ -38,19 +38,66 @@ module Cwsrb
         name: response['USER_NAME'],
         gender: response['USER_GENDER'],
         bio: response['USER_BIO'],
-        country: response['USER_COUNTRY']
+        country: response['USER_COUNTRY'],
+        karma: response['KARMA']
       }
 
-      # Now karma
-      response = self.class.get("/api?f=USER_KARMA&USER=#{usr}")
+      Cwsrb::User.new(attribs)
+    end
+
+    def get_lang(val)
+      response = self.class.get("/api/LANG/#{val}")
 
-      # Check if any errors occurred
       Cwsrb::Helpers.check_for_errors(response)
 
       response = response['out']
-      attribs[:karma] = [response['KARMA_UP'], response['KARMA_DOWN']]
+      attribs = {
+        code: response['CODE'],
+        name: response['NAME'],
+        native_name: response['NATIVE_NAME'],
+        ipa: response['IPA'],
+        type: get_lang_type(response['TYPE']),
+        owners: response['OWNERS'],
+        overview: response['OVERVIEW'],
+        public: response['PUBLIC'],
+        status: get_lang_status(response['STATUS']),
+        registered: Time.at(response['REGISTERED']),
+        word_count: response['WORD_COUNT']
+      }
 
-      Cwsrb::User.new(attribs)
+      Cwsrb::Language.new(attribs)
+    end
+
+    def get_lang_type(val)
+      response = self.class.get("/api/LANG/TYPE/#{val}")
+
+      Cwsrb::Helpers.check_for_errors(response)
+
+      response = response['out']
+      attribs = {
+        code: response['TYPE'].upcase,
+        desc: response['DESC']
+      }
+
+      Cwsrb::Language::Type.new(attribs)
+    end
+
+    def get_lang_status(val)
+      response = self.class.get("/api/LANG/STATUS/#{val}")
+
+      Cwsrb::Helpers.check_for_errors(response)
+
+      response = response['out']
+      attribs = {
+        code: response['STATUS'].upcase,
+        desc: response['DESC']
+      }
+
+      Cwsrb::Language::Status.new(attribs)
+    end
+
+    def api_version
+      self.class.get('/api')['api_ver']
     end
   end
 end

data/lib/cwsrb/data.rb

@@ -0,0 +1,110 @@
+module Cwsrb
+  # The User class represents a member of ConWorkShop.
+  class User
+    # @return [String, Integer] The User's ID
+    attr_reader :id
+
+    # @return [String] The User's name
+    attr_reader :name
+
+    # @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
+    attr_reader :bio
+
+    # @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
+    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 [User] a new instance of `User`
+    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
+
+  class Language
+    class Type
+      attr_reader :code
+      attr_reader :desc
+
+      def initialize(code: nil, desc: '')
+        @code = code
+        @desc = desc
+      end
+
+      def inspect
+        "<Language::Type code=#{@code} desc=#{@desc}>"
+      end
+    end
+
+    class Status
+      attr_reader :code
+      attr_reader :desc
+
+      def initialize(code: nil, desc: '')
+        @code = code
+        @desc = desc
+      end
+
+      def inspect
+        "<Language::Status code=#{@code} desc=#{@desc}>"
+      end
+    end
+
+    attr_reader :code
+    attr_reader :name
+    attr_reader :native_name
+    attr_reader :ipa
+    attr_reader :type
+    attr_reader :owners
+    attr_reader :overview
+    attr_reader :public
+    attr_reader :status
+    attr_reader :registered
+    attr_reader :word_count
+
+    def initialize(code: nil, name: nil, native_name: nil, ipa: nil, type: nil,
+                   owners: [], overview: '', public: true, status: '',
+                   registered: Time.now, word_count: 0)
+      @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
+    end
+
+    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}>"
+    end
+  end
+end

data/lib/cwsrb/errors.rb

@@ -1,12 +1,8 @@
 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.
+  # Raised when a general API error occurs.
   APIError = Class.new(Error)
-
-  # @!endgroup
 end

data/lib/cwsrb/helpers.rb

@@ -17,7 +17,7 @@ module Cwsrb
     # 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_
+    # @return [void]
     def check_for_errors(response)
       raise Cwsrb::APIError, response['err_msg'] if response['err_idx'] > 0
     end

data/lib/cwsrb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cwsrb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Unleashy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -103,9 +103,9 @@ files:
 - cwsrb.gemspec
 - lib/cwsrb.rb
 - lib/cwsrb/api.rb
+- lib/cwsrb/data.rb
 - lib/cwsrb/errors.rb
 - lib/cwsrb/helpers.rb
-- lib/cwsrb/user.rb
 - lib/cwsrb/version.rb
 homepage: https://github.com/unleashy/cwsrb
 licenses:

data/lib/cwsrb/user.rb

@@ -1,51 +0,0 @@
-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