rublox 0.1.0 → 0.2.0

data/lib/rublox/util/http_client.rb

@@ -1,95 +1,95 @@
-# frozen_string_literal: true
-
-require "http"
-require "json"
-
-require "rublox/util/errors"
-
-module Rublox
-  # @note Only use if you have an use case that the library doesn't cover (and
-  #   create an issue and perhaps we'll implement it!).
-  # The {HTTPClient} is a wrapper around the http library, designed specifically
-  # for the Roblox API. It automatically handles the X-CSRF-TOKEN and the
-  # .ROBLOSECURITY cookie.
-  class HTTPClient
-    # @param roblosecurity [String]
-    def initialize(roblosecurity = "")
-      @client = HTTP.cookies(
-        {
-          ".ROBLOSECURITY": roblosecurity
-        }
-      )
-    end
-
-    # Send a GET request to the specified URL.
-    # @param url [String]
-    # @return [Hash]
-    def get(url, *args)
-      request(:get, url, *args)
-    end
-
-    # Send a POST request to the specified URL.
-    # @param url [String]
-    # @return [Hash]
-    def post(url, *args)
-      request(:post, url, *args)
-    end
-
-    # Send a PATCH request to the specified URL.
-    # @param url [String]
-    # @return [Hash]
-    def patch(url, *args)
-      request(:patch, url, *args)
-    end
-
-    # Send a DELETE request to the specified URL.
-    # @param url [String]
-    # @return [Hash]
-    def delete(url, *args)
-      request(:delete, url, *args)
-    end
-
-    private
-
-    # @param verb [Symbol]
-    # @param url [String]
-    # @return [Hash]
-    def request(verb, url, *args)
-      response = @client.request(verb, url, *args)
-      return JSON.parse(response.body) if response.status == 200
-
-      handle_status_code(response, verb, url, *args)
-    end
-
-    # @param response [HTTP::Response]
-    def handle_status_code(response, verb, url, *args)
-      case response.status
-      # token validation failed
-      when 403
-        @client = @client.headers(
-          {
-            "x-csrf-token": response.headers["x-csrf-token"]
-          }
-        )
-        # retry the request
-        request(verb, url, *args)
-      # invalid .ROBLOSECURITY cookie
-      when 401
-        raise Errors::InvalidROBLOSECURITYError
-      else
-        raise Errors::UnhandledStatusCodeError.new(response.status, get_errors_from_response(response))
-      end
-    end
-
-    # @param response [HTTP::Response]
-    def get_errors_from_response(response)
-      body = JSON.parse(response.body)
-    rescue JSON::ParserError
-      "\ncould not parse errors, raw body:\n#{response.body}\n"
-    else
-      body["errors"].reduce("") do |error_message, error|
-        error_message + "\tCode: #{error['code']}\n\tMessage: #{error['message']}\n\n"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "http"
+require "json"
+
+require "rublox/util/errors"
+
+module Rublox
+  # @note Only use if you have an use case that the library doesn't cover (and
+  #   create an issue and perhaps we'll implement it!).
+  # The {HTTPClient} is a wrapper around the http library, designed specifically
+  # for the Roblox API. It automatically handles the X-CSRF-TOKEN and the
+  # .ROBLOSECURITY cookie.
+  class HTTPClient
+    # @param roblosecurity [String]
+    def initialize(roblosecurity = "")
+      @client = HTTP.cookies(
+        {
+          ".ROBLOSECURITY": roblosecurity
+        }
+      )
+    end
+
+    # Send a GET request to the specified URL.
+    # @param url [String]
+    # @return [Hash]
+    def get(url, *args)
+      request(:get, url, *args)
+    end
+
+    # Send a POST request to the specified URL.
+    # @param url [String]
+    # @return [Hash]
+    def post(url, *args)
+      request(:post, url, *args)
+    end
+
+    # Send a PATCH request to the specified URL.
+    # @param url [String]
+    # @return [Hash]
+    def patch(url, *args)
+      request(:patch, url, *args)
+    end
+
+    # Send a DELETE request to the specified URL.
+    # @param url [String]
+    # @return [Hash]
+    def delete(url, *args)
+      request(:delete, url, *args)
+    end
+
+    private
+
+    # @param verb [Symbol]
+    # @param url [String]
+    # @return [Hash]
+    def request(verb, url, *args)
+      response = @client.request(verb, url, *args)
+      return JSON.parse(response.body) if response.status == 200
+
+      handle_status_code(response, verb, url, *args)
+    end
+
+    # @param response [HTTP::Response]
+    def handle_status_code(response, verb, url, *args)
+      case response.status
+      # token validation failed
+      when 403
+        @client = @client.headers(
+          {
+            "x-csrf-token": response.headers["x-csrf-token"]
+          }
+        )
+        # retry the request
+        request(verb, url, *args)
+      # invalid .ROBLOSECURITY cookie
+      when 401
+        raise Errors::InvalidROBLOSECURITYError
+      else
+        raise Errors::UnhandledStatusCodeError.new(response.status, get_errors_from_response(response))
+      end
+    end
+
+    # @param response [HTTP::Response]
+    def get_errors_from_response(response)
+      body = JSON.parse(response.body)
+    rescue JSON::ParserError
+      "\ncould not parse errors, raw body:\n#{response.body}\n"
+    else
+      body["errors"].reduce("") do |error_message, error|
+        error_message + "\tCode: #{error['code']}\n\tMessage: #{error['message']}\n\n"
+      end
+    end
+  end
+end

data/lib/rublox/util/pages.rb

@@ -1,85 +1,85 @@
-# frozen_string_literal: true
-
-require "rublox/util/url"
-require "rublox/util/cache"
-
-module Rublox
-  # The order to sort pages in.
-  module SortOrder
-    # Sort the pages ina ascending order.
-    ASCENDING = "Asc"
-    # Sort the pages in descending order.
-    DESCENDING = "Desc"
-  end
-
-  # The {Pages} class acts as an iterator over pages returned by the API.
-  # @!visibility private
-  # @todo Make more customizable, polish and battle-test
-  # @note Only use if you have an use case that the library doesn't cover (and
-  #   create an issue and perhaps we'll implement it!).
-  class Pages
-    # How many items are returned per page
-    PAGE_DATA_LIMIT = 100
-
-    # @!visibility private
-    DEFAULT_REQUEST_PARAMETERS = {
-      params: {
-        sortOrder: SortOrder::DESCENDING,
-        limit: PAGE_DATA_LIMIT
-      }
-    }.freeze
-
-    # @param client [Client]
-    # @param initial_data [Hash]
-    # @param url [String]
-    # @param request_params [Hash]
-    def initialize(client, initial_data, url, request_params = {}, &data_handler)
-      request_params[:params] = DEFAULT_REQUEST_PARAMETERS[:params].merge(
-        request_params
-      )
-
-      @client = client
-      @raw_data = initial_data
-      @url = url
-      @request_parameters = request_parameters
-      @data_handler = data_handler
-
-      @data = []
-    end
-
-    # Iterate over the pages
-    def each
-      raise unless block_given?
-      # i = 0
-
-      # until @raw_data
-      #   if i == @data.length
-      #     i = 0
-      #     data = Cache.get(Cache::PAGE, @raw_data["nextPageCursor"])
-      #     if data
-      #       @data = data
-      #     else
-      #       @raw_data, @data = next_page
-      #       break if @raw_data.empty?
-
-      #       Cache.set(Cache::PAGE, @raw_data["nextPageCursor"], @data)
-      #     end
-      #   end
-
-      #   yield @data[i]
-      #   i += 1
-      # end
-    end
-
-    private
-
-    # @return [Array] tuple {raw data, processed data}
-    def next_page
-      @request_parameters[:params][:cursor] = @raw_data["nextPageCursor"]
-
-      data = @client.http_client.get(@url, @request_parameters)
-
-      [data["data"], @data_handler.call(data["data"])]
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/util/url"
+require "rublox/util/cache"
+
+module Rublox
+  # The order to sort pages in.
+  module SortOrder
+    # Sort the pages ina ascending order.
+    ASCENDING = "Asc"
+    # Sort the pages in descending order.
+    DESCENDING = "Desc"
+  end
+
+  # The {Pages} class acts as an iterator over pages returned by the API.
+  # @!visibility private
+  # @todo Make more customizable, polish and battle-test
+  # @note Only use if you have an use case that the library doesn't cover (and
+  #   create an issue and perhaps we'll implement it!).
+  class Pages
+    # How many items are returned per page
+    PAGE_DATA_LIMIT = 100
+
+    # @!visibility private
+    DEFAULT_REQUEST_PARAMETERS = {
+      params: {
+        sortOrder: SortOrder::DESCENDING,
+        limit: PAGE_DATA_LIMIT
+      }
+    }.freeze
+
+    # @param client [Client]
+    # @param initial_data [Hash]
+    # @param url [String]
+    # @param request_params [Hash]
+    def initialize(client, initial_data, url, request_params = {}, &data_handler)
+      request_params[:params] = DEFAULT_REQUEST_PARAMETERS[:params].merge(
+        request_params
+      )
+
+      @client = client
+      @raw_data = initial_data
+      @url = url
+      @request_parameters = request_parameters
+      @data_handler = data_handler
+
+      @data = []
+    end
+
+    # Iterate over the pages
+    def each
+      raise unless block_given?
+      # i = 0
+
+      # until @raw_data
+      #   if i == @data.length
+      #     i = 0
+      #     data = Cache.get(Cache::PAGE, @raw_data["nextPageCursor"])
+      #     if data
+      #       @data = data
+      #     else
+      #       @raw_data, @data = next_page
+      #       break if @raw_data.empty?
+
+      #       Cache.set(Cache::PAGE, @raw_data["nextPageCursor"], @data)
+      #     end
+      #   end
+
+      #   yield @data[i]
+      #   i += 1
+      # end
+    end
+
+    private
+
+    # @return [Array] tuple {raw data, processed data}
+    def next_page
+      @request_parameters[:params][:cursor] = @raw_data["nextPageCursor"]
+
+      data = @client.http_client.get(@url, @request_parameters)
+
+      [data["data"], @data_handler.call(data["data"])]
+    end
+  end
+end

data/lib/rublox/util/url.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-
-module Rublox
-  # Module for making URLs.
-  module URL
-    # The base URL to be used. If using a proxy, you can change the URL as long
-    # as it follows Roblox's API structure:
-    #   https://users.roblox.com/v1/users/1
-    #   Bad:
-    #   https://myproxy.test/get-user/1
-    #   https://myproxy.test/users/1
-    #   https://users.myproxy.test/users/1
-    #   Good:
-    #   https://users.myproxy.test/v1/users/1
-    BASE_URL = "roblox.com"
-
-    # Creates an endpoint URL from the the given ApiSite and path.
-    # @param api_site [String] ApiSite
-    # @param path [String]
-    # @return [String] the endpoint
-    def self.endpoint(api_site, path)
-      "https://#{api_site}.#{BASE_URL}/#{path}"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Rublox
+  # Module for making URLs.
+  module URL
+    # The base URL to be used. If using a proxy, you can change the URL as long
+    # as it follows Roblox's API structure:
+    #   https://users.roblox.com/v1/users/1
+    #   Bad:
+    #   https://myproxy.test/get-user/1
+    #   https://myproxy.test/users/1
+    #   https://users.myproxy.test/users/1
+    #   Good:
+    #   https://users.myproxy.test/v1/users/1
+    BASE_URL = "roblox.com"
+
+    # Creates an endpoint URL from the the given ApiSite and path.
+    # @param api_site [String] ApiSite
+    # @param path [String]
+    # @return [String] the endpoint
+    def self.endpoint(api_site, path)
+      "https://#{api_site}.#{BASE_URL}/#{path}"
+    end
+  end
+end

data/lib/rublox/version.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-module Rublox
-  # Current version of rublox
-  VERSION = "0.1.0"
-end
+# frozen_string_literal: true
+
+module Rublox
+  # Current version of rublox
+  VERSION = "0.2.0"
+end