elessar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 397fc3055adbb9d6d5a8415a5709e22899cc90fd471552ca810566b9dcc4cbaa
+  data.tar.gz: 693aa15f1092a68147bf7cc35f324f1f52329921a850fa1be29d0d1cec4aa949
+SHA512:
+  metadata.gz: 9e2b4cc37588bb6b9455099a204fcb1f1e0a772acce9ec14558eb580465f0b0bef4eeb5bb33be9ba3ca074eb60b3fcda10bab4051a93437c017468266cd4d62a
+  data.tar.gz: 0b753bcb26d4aedda291524c67a6e84ea72154c0e571c251031075cd23c71a9bb6585464ab1004191fa4a13308bbd09cd7268836125cd70ab521d3036181bcac

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    elessar (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    power_assert (1.2.0)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    test-unit (3.3.7)
+      power_assert
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  elessar!
+  mocha
+  rake
+  test-unit
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -0,0 +1,111 @@
+# Elessar Ruby Library
+
+Elessar - In the book, Elessar is a green gemstone that is a symbol of the kingship of Gondor.
+
+The Elessar Ruby library provides convenient access to the The Lord of the Rings API from
+applications written in the Ruby language.
+
+## Documentation
+
+See the [The Lord of the Rings API docs](https://the-one-api.dev/documentation).
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use the package, just run:
+
+```sh
+gem install elessar
+```
+
+If you want to build the gem from source:
+
+```sh
+gem build elessar.gemspec
+```
+
+### Requirements
+
+- Ruby 2.3+.
+
+### Bundler
+
+If you are installing via bundler, you should be sure to use the https rubygems
+source in your Gemfile, as any gems fetched over http could potentially be
+compromised in transit and alter the code of gems fetched securely over https:
+
+```ruby
+gem 'elessar'
+```
+
+## Usage
+
+The library needs to be configured with your account's secret key which is
+available in your [The Lord of the Rings Account](https://the-one-api.dev/account). Set `Elessar.api_key` to its
+value:
+
+```ruby
+require 'elessar'
+Elessar.api_key = 'aR9j-...'
+
+# list movies
+Elessar::Movie.list()
+
+# retrieve single movie
+movie = Elessar::Movie.retrieve('5cd95395de30eff6ebccde5b')
+
+# list quotes
+movie.list_quotes()
+```
+
+### Params
+```ruby
+# using params as hash
+Elessar::Movie.list({limit: 3, page: 2})
+
+# using params as string
+Elessar::Movie.list("budgetInMillions<100")
+```
+
+
+### Configuring Automatic Retries
+
+You can enable automatic retries on requests that fail due to a transient
+problem by configuring the maximum number of retries:
+
+```ruby
+Elessar.max_network_retries = 2
+```
+
+Various errors can trigger a retry, like a connection error or a timeout, and
+also certain API responses like HTTP status `409 Conflict`.
+
+### Configuring Timeouts
+
+Open, read timeouts are configurable:
+
+```ruby
+Elessar.open_timeout = 30 # in seconds
+Elessar.read_timeout = 80
+```
+
+
+## Development
+
+Instructions to run tests:
+
+```sh
+bundle install
+```
+
+Run all tests:
+
+```sh
+bundle exec ruby test/run_test.rb
+```
+
+Run a single test:
+
+```sh
+bundle exec ruby test/elessar_test.rb
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/sdk-console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "irb"
+require "irb/completion"
+
+require "#{::File.dirname(__FILE__)}/../lib/sdk.rb"
+
+# Config IRB to enable --simple-prompt and auto indent
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+
+puts "Loaded gem 'murilo-zaffalon-sdk'"
+
+IRB.start

data/designer.md

@@ -0,0 +1,22 @@
+### Designer
+
+You can add `opts` to add some headers to the request.
+
+```ruby
+# get movie by id
+Elessar::Movie.retrieve(id, opts = {})
+
+# get all movies
+movie = Elessar::Movie.list(filters = {limit: 10}, opts = {})
+
+# You can acces the data
+movie.docs.first.name
+
+# get all quotes from a movie
+quote = movie.list_quotes(filters = { limit: 10 }, opts = {})
+
+quote.docs.first.dialog
+
+# For Custom searches you can use the filters passing the string
+Elessar::Movie.list("budgetInMillions<100")
+```

data/elessar.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+Gem::Specification.new do |s|
+  s.name = "elessar"
+  s.version = "0.0.1"
+  s.required_ruby_version = ">= 2.3.0"
+
+  s.authors = ["Murilo Zaffalon"]
+  s.date = %q{2023-03-05}
+  s.description = %q{A simple SDK for Murilo Zaffalon, Elessar - In the book, Elessar is a green gemstone that is a symbol of the kingship of Gondor.}
+  s.email = %q{mzaffalon@hotmail.com}
+  # s.test_files = ["test/test_hola.rb"]
+  s.homepage = %q{http://rubygems.org/gems/elessar}
+  s.summary = %q{Murilo Zaffalon SDK!}
+
+  ignored = Regexp.union(
+    "elessar-0.0.1.gem",
+    /\A\.git/,
+    /\A\.vscode/,
+    /\Atest/
+  )
+  s.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rake"
+  gem "mocha"
+
+  gem "test-unit"
+end

data/lib/elessar/api_operations/request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Elessar
+  module APIOperations
+    module Request
+      module ClassMethods
+        def request(method, url, params = {}, opts = {})
+          connection = Elessar::ConnectionManager.new
+          connection.execute_request(
+            method,
+            url,
+            query: params,
+            headers: opts,
+          )
+        end
+      end
+
+      def request(method, url, params = {}, opts = {})
+        connection = Elessar::ConnectionManager.new
+        connection.execute_request(
+          method,
+          url,
+          query: params,
+          headers: opts,
+        )
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/elessar/connection_manager.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Elessar
+  class ConnectionManager
+    attr_reader :config
+
+    def initialize(config = Elessar.config)
+      @config = config
+      @active_connections = {}
+    end
+
+    def connection_for(uri)
+      u = URI.parse(uri)
+      connection = @active_connections[[u.host, u.port]]
+
+      if connection.nil?
+        connection = create_connection(u)
+        connection.start
+
+        @active_connections[[u.host, u.port]] = connection
+      end
+
+      connection
+    end
+
+    def authorization_headers
+      headers = {
+        "Authorization" => "Bearer #{Elessar.api_key}",
+        "Content-Type" => "application/json",
+      }
+    end
+
+    def execute_request(method, uri, body: nil, headers: {}, query:, &block)
+      raise ArgumentError, "method should be a symbol" unless method.is_a?(Symbol)
+      raise ArgumentError, "uri should be a string" unless uri.is_a?(String)
+      raise ArgumentError, "body should be a string" if body && !body.is_a?(String)
+      raise ArgumentError, "headers should be a hash" if headers && !headers.is_a?(Hash)
+      raise ArgumentError, "query should be a hash or string" if query && (!query.is_a?(Hash) and !query.is_a?(String))
+
+      headers = headers.merge(authorization_headers)
+      uri = Elessar.api_base + uri
+
+      connection = connection_for(uri)
+
+      u = URI.parse(uri)
+      path = case query
+        when String
+          u.path + "?" + query
+        when Hash
+          u.path + "?" + URI.encode_www_form(query)
+        else
+          u.path
+        end
+
+      method_name = method.to_s.upcase
+      has_response_body = method_name != "HEAD"
+      request = Net::HTTPGenericRequest.new(
+        method_name,
+        (body ? true : false),
+        has_response_body,
+        path,
+        headers
+      )
+
+      http_resp = begin
+          retries ||= 0
+          connection.request(request, body, &block)
+        rescue
+          retry if (retries += 1) < Elessar.max_network_retries
+        end
+
+      begin
+        resp = ElessarResponse.from_net_http(http_resp)
+      rescue JSON::ParserError
+        raise general_api_error(http_resp.code.to_i, http_resp.body)
+      end
+    end
+
+    private def create_connection(uri)
+      connection = Net::HTTP.new(uri.host, uri.port)
+
+      connection.use_ssl = true
+      connection.keep_alive_timeout = 30
+      connection.open_timeout = config.open_timeout
+      connection.read_timeout = config.read_timeout
+
+      connection
+    end
+
+    private def general_api_error(status, body)
+      StandardError.new("Invalid response object from API: #{body.inspect} " \
+      "(HTTP response code was #{status})")
+    end
+  end
+end

data/lib/elessar/elessar_configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Elessar
+  class ElessarConfiguration
+    attr_accessor :api_key
+    attr_accessor :api_version
+
+    attr_reader :api_base
+    attr_reader :max_network_retries
+    attr_reader :open_timeout
+    attr_reader :read_timeout
+
+    def self.setup
+      new.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
+
+    def initialize
+      @max_network_retries = 0
+
+      @open_timeout = 30
+      @read_timeout = 80
+
+      @api_base = "https://the-one-api.dev/v2/"
+    end
+
+    def max_network_retries=(val)
+      @max_network_retries = val.to_i
+    end
+
+    def open_timeout=(open_timeout)
+      @open_timeout = open_timeout
+    end
+
+    def read_timeout=(read_timeout)
+      @read_timeout = read_timeout
+    end
+
+    def api_base=(api_base)
+      @api_base = api_base
+    end
+  end
+end

data/lib/elessar/elessar_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Elessar
+  class ElessarResponseHeaders
+    def self.from_net_http(resp)
+      new(resp.to_hash || resp.to_h)
+    end
+
+    def initialize(hash)
+      return if hash.nil?
+      @hash = {}
+
+      hash.each do |k, v|
+        @hash[k.downcase] = v
+      end
+    end
+  end
+
+  module ElessarResponseBase
+    attr_accessor :http_headers
+    attr_accessor :http_status
+
+    def self.populate_for_net_http(resp, http_resp)
+      resp.http_headers = ElessarResponseHeaders.from_net_http(http_resp)
+      resp.http_status = http_resp.code.to_i
+    end
+  end
+
+  class ElessarResponse
+    include ElessarResponseBase
+
+    attr_accessor :data
+    attr_accessor :http_body
+
+    def self.from_net_http(http_resp)
+      resp = ElessarResponse.new
+      resp.data = JSON.parse(http_resp.body, object_class: OpenStruct)
+      resp.http_body = http_resp.body
+      ElessarResponseBase.populate_for_net_http(resp, http_resp)
+      resp
+    end
+  end
+
+  ElessarResponse::Headers = ElessarResponseHeaders
+end

data/lib/elessar/resources/movie.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Elessar
+  class Movie
+    include Elessar::APIOperations::Request
+
+    attr_accessor :id, :data
+
+    def initialize(id, data = {})
+      @id = id
+      @data = data
+    end
+
+    OBJECT_NAME = "movie"
+
+    def self.retrieve(id, opts = {})
+      url = resource_url + "/#{id}"
+      resp = request(:get, url, params = nil, opts = opts)
+      new(id, resp.data)
+    end
+
+    def self.list(filters = { limit: 10 }, opts = {})
+      resp = request(:get, resource_url, params = filters, opts = opts)
+      new(nil, resp.data)
+    end
+
+    def list_quotes(filters = { limit: 10 }, opts = {})
+      url = "#{resource_url}/#{id}/quote"
+      resp = request(:get, url, params = filters, opts = opts)
+      Elessar::Quote.new(nil, resp.data)
+    end
+
+    def self.resource_url
+      "#{OBJECT_NAME}"
+    end
+
+    def resource_url
+      "#{OBJECT_NAME}"
+    end
+  end
+end

data/lib/elessar/resources/quote.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Elessar
+  class Quote
+    include Elessar::APIOperations::Request
+
+    attr_accessor :id, :data
+
+    def initialize(id, data = {})
+      @id = id
+      @data = data
+    end
+
+    OBJECT_NAME = "quote"
+
+    def self.list(filters = { limit: 10 }, opts = {})
+      resp = request(:get, resource_url, params = filters, opts = opts)
+      new(nil, resp.data)
+    end
+
+    def self.resource_url
+      "#{OBJECT_NAME}"
+    end
+
+    def resource_url
+      "#{OBJECT_NAME}"
+    end
+  end
+end

data/lib/elessar/resources.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "elessar/resources/movie"
+require "elessar/resources/quote"

data/lib/elessar.rb

@@ -0,0 +1,29 @@
+require "net/http"
+require "json"
+require "forwardable"
+
+# API operations
+require "elessar/api_operations/request"
+
+require "elessar/elessar_configuration"
+require "elessar/connection_manager"
+require "elessar/elessar_response"
+
+require "elessar/resources"
+
+module Elessar
+  @config = Elessar::ElessarConfiguration.setup
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :api_version, :api_version=
+    def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :open_timeout, :open_timeout=
+    def_delegators :@config, :read_timeout, :read_timeout=
+    def_delegators :@config, :max_network_retries, :max_network_retries=
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: elessar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Murilo Zaffalon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies: []
+description: A simple SDK for Murilo Zaffalon, Elessar - In the book, Elessar is a
+  green gemstone that is a symbol of the kingship of Gondor.
+email: mzaffalon@hotmail.com
+executables:
+- sdk-console
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/sdk-console
+- designer.md
+- elessar.gemspec
+- gemfile
+- lib/.DS_Store
+- lib/elessar.rb
+- lib/elessar/.DS_Store
+- lib/elessar/api_operations/request.rb
+- lib/elessar/connection_manager.rb
+- lib/elessar/elessar_configuration.rb
+- lib/elessar/elessar_response.rb
+- lib/elessar/resources.rb
+- lib/elessar/resources/movie.rb
+- lib/elessar/resources/quote.rb
+homepage: http://rubygems.org/gems/elessar
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Murilo Zaffalon SDK!
+test_files: []