rdwu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 013b2c1e698ff1acd92fce949bb54cdd777f62b515ea913d0e2982d36f9ba428
+  data.tar.gz: 47fc53c71342d92f4c06795a54e26f7a54fc77ddea2867e164e1be21e8c00dcf
+SHA512:
+  metadata.gz: bdcbc97c172095defe6cf3142c6d7685ba51bd7bc7d55ae9b785dc0410d8709bfd8e13282cf82baf8386946f4b5d7d1595572388f2e46892ec93c4f303a6d5ff
+  data.tar.gz: 5ee81f3d5c03adf9cbbecd56bad73251d80d42ddac053688ed3119a9775f0562aace232e10c7f6dc59c3e41b9fa0ae1bca8be400ca73c3dae7532aa30fe16d9d

data/.rbenv-vars.example

@@ -0,0 +1,4 @@
+RDWU_ENABLED=true
+RDWU_API_KEY=
+RDWU_HOST=http://localhost:3000
+RDWU_TIMEOUT_SECONDS=3

data/README.md

@@ -0,0 +1,130 @@
+# Rdwu
+
+Client for Redirect Web URL
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rdwu
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rdwu
+```
+
+## Setup
+
+In the environment variable set the folowings
+
+```shell
+RDWU_ENABLED=true
+RDWU_API_KEY=
+RDWU_HOST=http://localhost:3004
+RDWU_TIMEOUT_SECONDS=3
+```
+
+## Usage
+
+### List
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.list
+[
+  {
+    "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+    "type" => "web_redirect",
+    "attributes" => {
+      "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+      "name" => "Test ma",
+      "to_url" => "http://adawd.com",
+      "is_permanent" => false,
+      "is_enabled" => true,
+      "expires_on" => nil,
+      "external_link" => "http://localhost:3000/0198cf30-f234-708e-afd1-d5a96c270a97"
+    }
+  }
+]
+```
+
+### Find
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.find('http://adawd.com')
+{
+  "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+  "type" => "web_redirect",
+  "attributes" => {
+    "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+    "name" => "Test ma",
+    "to_url" => "http://adawd.com",
+    "is_permanent" => false,
+    "is_enabled" => true,
+    "expires_on" => nil,
+    "external_link" => "http://localhost:3000/0198cf30-f234-708e-afd1-d5a96c270a97"
+  }
+}
+```
+
+### Retrieve
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.retrieve('0198cf30-f234-708e-afd1-d5a96c270a97')
+{
+  "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+  "type" => "web_redirect",
+  "attributes" => {
+    "id" => "0198cf30-f234-708e-afd1-d5a96c270a97",
+    "name" => "Test ma",
+    "to_url" => "http://adawd.com",
+    "is_permanent" => false,
+    "is_enabled" => true,
+    "expires_on" => nil,
+    "external_link" => "http://localhost:3000/0198cf30-f234-708e-afd1-d5a96c270a97"
+  }
+}
+```
+
+### Create
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.create(
+  {
+    name: 'Test ma',
+    to_url: 'http://adawd.com',
+    is_permanent: false,
+    is_enabled: true,
+    expires_on: nil
+  }
+)
+```
+
+### Update
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.update(
+  '0198cf30-f234-708e-afd1-d5a96c270a97',
+  {
+    name: 'Test ma',
+    to_url: 'http://adawd.com',
+    is_permanent: false,
+    is_enabled: true,
+    expires_on: nil
+  }
+)
+```
+
+### Delete
+
+```ruby
+rdwu = Rdwu::Api.new
+rdwu.delete('0198cf30-f234-708e-afd1-d5a96c270a97')
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/rdwu/read.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Rdwu::Read
+  def list
+    http = get_request('/api/v1/web_redirects')
+    body = JSON.parse(http.body)
+    body['data']
+  end
+
+  def find(url)
+    http = get_request("/api/v1/web_redirects/find?url=#{url}")
+
+    if http.status == 200
+      body = JSON.parse(http.body)
+      return body['data']
+    end
+
+    nil
+  end
+
+  def retrieve(uuid)
+    http = get_request("/api/v1/web_redirects/#{uuid}")
+
+    if http.status == 200
+      body = JSON.parse(http.body)
+      return body['data']
+    end
+
+    nil
+  end
+end

data/lib/rdwu/settings.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Rdwu::Settings
+  def enabled?
+    %w[true on 1 enabled yes].include?(ENV['RDWU_ENABLED']&.downcase)
+  end
+
+  def token
+    ENV['RDWU_API_KEY']
+  end
+
+  def host
+    ENV['RDWU_HOST']
+  end
+
+  def timeout_seconds
+    (ENV['RDWU_TIMEOUT_SECONDS'] || 3).to_i
+  end
+end

data/lib/rdwu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rdwu
+  VERSION = '0.1.0'
+end

data/lib/rdwu/write.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Rdwu::Write
+  def create(payload)
+    http = post_request('/api/v1/web_redirects', payload)
+
+    if http.status == 200 || http.status == 201
+      body = JSON.parse(http.body)
+      return body['data']
+    end
+
+    return { 'errors': JSON.parse(http.body) } if http.status == 422
+
+    nil
+  end
+
+  def update(uuid, payload)
+    http = post_request("/api/v1/web_redirects/#{uuid}", payload)
+
+    if http.status == 200
+      body = JSON.parse(http.body)
+      return body['data']
+    end
+
+    return { 'errors': JSON.parse(http.body) } if http.status == 422
+    return { 'errors': { 'message': 'Not found!' }  } if http.status == 404
+
+    nil
+  end
+
+  def delete(uuid)
+    http = delete_request("/api/v1/web_redirects/#{uuid}")
+
+    return true if http.status == 204
+    false
+  end
+end

data/lib/rdwu.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'pry'
+
+require_relative 'rdwu/version'
+
+module Rdwu
+  require_relative 'rdwu/settings'
+  require_relative 'rdwu/read'
+  require_relative 'rdwu/write'
+
+  class Error < StandardError; end
+
+  class Api
+    include JSON
+    include Settings
+    include Read
+    include Write
+
+    def get_request(path)
+      return nil unless enabled?
+
+      path = [host, path].join
+
+      HTTP
+        .timeout(timeout_seconds)
+        .headers(token:)
+        .get(path)
+    end
+
+    def post_request(path, payload)
+      return nil unless enabled?
+
+      path = [host, path].join
+
+      HTTP
+        .timeout(timeout_seconds)
+        .headers(token:)
+        .post(path, json: payload)
+    end
+
+    def delete_request(path)
+      return nil unless enabled?
+
+      path = [host, path].join
+
+      HTTP
+        .timeout(timeout_seconds)
+        .headers(token:)
+        .delete(path)
+    end
+  end
+end

data/sig/rdwu/api.rbs

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rdwu
+  class Api
+    def get_request: -> HTTP::Response
+    def post_request: -> HTTP::Response
+    def delete_request: -> HTTP::Response
+  end
+end

data/sig/rdwu/read.rbs

@@ -0,0 +1,47 @@
+module Rdwu
+  module Read
+    def list: -> [
+        {
+          "id" => "uuid",
+          "type" => "web_redirect",
+          "attributes" => {
+              "id" => "uuid",
+              "name" => String,
+              "to_url" => String,
+              "is_permanent" => bool,
+              "is_enabled" => bool,
+              "expires_on" => "2025-12-28" | nil,
+              "external_link" => String
+            }
+        }
+      ]
+
+    def find: -> {
+        "id" => "uuid",
+        "type" => "web_redirect",
+        "attributes" => {
+            "id" => "uuid",
+            "name" => String,
+            "to_url" => String,
+            "is_permanent" => bool,
+            "is_enabled" => bool,
+            "expires_on" => "2025-12-28" | nil,
+            "external_link" => String
+          }
+      }
+
+    def retrieve: -> {
+        "id" => "uuid",
+        "type" => "web_redirect",
+        "attributes" => {
+            "id" => "uuid",
+            "name" => String,
+            "to_url" => String,
+            "is_permanent" => bool,
+            "is_enabled" => bool,
+            "expires_on" => "2025-12-28" | nil,
+            "external_link" => String
+          }
+      }
+  end
+end

data/sig/rdwu/settings.rbs

@@ -0,0 +1,10 @@
+module Rdwu
+  module Settings
+    def enabled?: -> bool
+
+    def host: -> String
+    def token: -> String
+
+    def timeout_seconds: -> Integer
+  end
+end

data/sig/rdwu/write.rbs

@@ -0,0 +1,33 @@
+module Rdwu
+  module Write
+    def create: -> {
+        "id" => "uuid",
+        "type" => "web_redirect",
+        "attributes" => {
+            "id" => "uuid",
+            "name" => String,
+            "to_url" => String,
+            "is_permanent" => bool,
+            "is_enabled" => bool,
+            "expires_on" => "2025-12-28" | nil,
+            "external_link" => String
+          }
+      }
+
+    def update: -> {
+        "id" => "uuid",
+        "type" => "web_redirect",
+        "attributes" => {
+            "id" => "uuid",
+            "name" => String,
+            "to_url" => String,
+            "is_permanent" => bool,
+            "is_enabled" => bool,
+            "expires_on" => "2025-12-28" | nil,
+            "external_link" => String
+          }
+      }
+
+    def delete: -> bool
+  end
+end

data/sig/rdwu.rbs

@@ -0,0 +1,4 @@
+module Rdwu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rdwu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Saimon Lovell
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: ipaddr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Does an API call to the RDWU to shorten the url and get a shortened URL
+email:
+- staysynchronize@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rbenv-vars.example"
+- README.md
+- Rakefile
+- lib/rdwu.rb
+- lib/rdwu/read.rb
+- lib/rdwu/settings.rb
+- lib/rdwu/version.rb
+- lib/rdwu/write.rb
+- sig/rdwu.rbs
+- sig/rdwu/api.rbs
+- sig/rdwu/read.rbs
+- sig/rdwu/settings.rbs
+- sig/rdwu/write.rbs
+homepage: https://gitlab.com/redirect-web-url/rdwu-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/redirect-web-url/rdwu-gem
+  source_code_uri: https://gitlab.com/redirect-web-url/rdwu-gem
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Shorten the url
+test_files: []