derek_hall-sdk 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf8a7f24372150b936ddc3d3d5cbe9bf4ea0fe28f7f8ec837ad8ef0ca310d92f
+  data.tar.gz: ee0ae3a9306cd76a1d8767e4ab1d64479bae94c10ac91c1f81ee0830d80f5a62
+SHA512:
+  metadata.gz: 063ad2aeeb3112aeec5b3ee1718c1d275c9289fa833e4be48d95634058675d29a8116bbd14a48900ff6d90078fef297a19fea446eadd723aaa0529b6061e6e43
+  data.tar.gz: b7defaf60e45157e1fc9d0e889de44d1492b8f6564ec2f2bc914a97edc29567e4940501931ca60068ccffaa3e0229f3aba9bea00be94208e8a9ef4db35b43caf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lotr-sdk.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'http'
+
+group :test do
+    gem 'webmock'
+    gem 'vcr'
+end

data/README.md

@@ -0,0 +1,59 @@
+
+# LOTR SDK
+
+Ruby client for the LOTR api located at https://the-one-api.dev/
+
+## Installation
+	gem install derek_hall-SDK
+
+## Usage
+In your ruby file
+
+	gem 'derek_hall-SDK'
+	require 'lotr/sdk'
+
+	client = Lotr::Sdk::Client.new(ENV['KEY'])
+
+	# grab a random quote
+	random_quote = client.quote_list.data.sample
+	puts "Who said #{random_quote['dialog']}?"
+
+	# get the name and race of the character who was quoted
+	character = client.character(id: random_quote['character']).data.first
+	puts "Answer: #{character['name']} - #{character['race']}"
+
+	# gather all pages of quote data
+
+	full_quote_data = []
+	next_page_number = 1
+	while next_page_number
+	  quote_list = client.quote_list(page:next_page_number)
+	  full_quote_data += quote_list.data
+	  next_page_number = quote_list.next_page_number
+	end
+
+	puts "Total number of quotes: #{full_quote_data.size}"
+
+## Supported commands
+
+* movie_list
+* movie
+* character_list
+* character
+* book_list
+* book
+* quote_list
+* quote
+
+## Local development
+	git clone https://github.com/dhall/derek_hall-SDK.git
+	cd derek_hall-SDK
+	bundle
+
+Run tests
+
+	rake test
+
+Build gem
+
+	rake build

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lotr/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/design.md

@@ -0,0 +1,21 @@
+# LOTR SDK Design Approach
+
+## Constraints
+I needed to time-box this initial version to under 5 hours of effort. Design constraints are a good thing to practice, as in real world problems there are always constraints to consider (time, resources, other requirements, etc).
+
+## Priorities
+Since I knew I would be limited on time, I wanted to get the 'plumbing' in place and prioritize what I worked on. I think it's important to have a testing approach that doesn't rely on the availability of any third party APIs. A few reasons for that are
+* Availability: the status of an API or connectivity to a network should not stop your tests from completing
+* Good stewardship: my development tests will may run very frequently and it's not nice to flood an API with a lot of wasted requests from your test suite
+* Resource management: this API is rate limited, so our tests could cause our real usage to get timed out, but especially in cases where you are paying for a specified amount of requests
+
+After the general dev and build overhead was in place, I started building out the usage of SDK. I didn't want a user to need to know a lot about the API or about REST APIs in general. I designed a client that gets instantiated with the secret key. The requests take a natural language approach such as `movie_list` to get a list of movies.
+
+I wanted the data returned to be more than raw json data, so it knows something about itself. I called this a `dataset` and the user can easily determine if they have data or an error by methods of those names. When data is present, the dataset also has `meta` information that can be used to gather additional pages of data. As long as `next_page_number` is a truthy value, there is more data available.
+
+## Future Direction
+Even with this simple API, building a robust SDK takes a lot of work. I've only started that process with this first version. Some clear next steps would be
+
+* Sorting, ordering, filtering: the API has robust support for these operations so it would be a nice addition to allow doing this on the API side. This would keep from needing to pull all data into the client just to search for a particular entry, for example.
+* Test coverage: The framework and approach is in place, so adding more comprehensive tests would be a good use of time.
+* Full datasets: Adding a method that loops through the operations and gets all data would be useful. It's straightforward to do this on the client side but it would be a nice convenience.

data/lib/lotr/sdk/client.rb

@@ -0,0 +1,56 @@
+require 'http'
+module Lotr
+  module Sdk
+    class Client
+
+      def initialize(key)
+        @key = key
+        @base_url = 'https://the-one-api.dev/v2'
+      end
+
+      def query_api(endpoint,page=nil)
+        page_param = "page=#{page}" if page
+        HTTP.auth("Bearer #{@key}").get("#{@base_url}/#{endpoint}?#{page_param}")
+      end
+
+      # Movies
+      def movie_list(page:1)
+        Dataset.new( query_api('movie',page) )
+      end
+
+      def movie(id:)
+        Dataset.new( query_api("movie/#{id}") )
+      end
+
+      # Books
+      def book_list(page:1)
+        Dataset.new( query_api('book',page) )
+      end
+
+      def book(id:)
+        Dataset.new( query_api("book/#{id}") )
+      end
+
+      # Quotes
+      def quote_list(page:1)
+        Dataset.new( query_api('quote',page) )
+      end
+
+      def quote(id:)
+        Dataset.new( query_api("quote/#{id}") )
+      end
+
+      # Characters
+      def character_list(page:1)
+        Dataset.new( query_api('character',page) )
+      end
+
+      def character(id:)
+        Dataset.new( query_api("character/#{id}") )
+      end
+
+
+    end
+
+  end
+end

data/lib/lotr/sdk/dataset.rb

@@ -0,0 +1,31 @@
+
+module Lotr
+  module Sdk
+    class Dataset
+      attr_accessor :data, :meta, :error
+      def initialize(response)
+        if response.code < 300
+          list = response.parse
+          @data = list['docs']
+          @meta = {
+            total_count: list['total'],
+            current_page: list['page'],
+            total_pages: list['pages']
+          }
+        else
+          @error = {
+            error_code: response.code,
+            error_message: response.to_s
+          }
+        end
+      end
+
+      def next_page_number
+        return nil if @error
+        @meta[:current_page] < @meta[:total_pages] ? @meta[:current_page] + 1 : nil
+      end
+
+    end
+
+  end
+end

data/lib/lotr/sdk/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lotr
+  module Sdk
+    VERSION = "0.3.0"
+  end
+end

data/lib/lotr/sdk.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "sdk/version"
+require_relative "sdk/client"
+require_relative "sdk/dataset"
+
+module Lotr
+  module Sdk
+    class Error < StandardError; end
+
+
+  end
+end

data/lotr-sdk.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/lotr/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "derek_hall-sdk"
+  spec.version       = Lotr::Sdk::VERSION
+  spec.authors       = ["Derek Hall"]
+  spec.email         = ["derekhall77@gmail.com"]
+
+  spec.summary       = "SDK for LOTR api"
+  spec.description   = "SDK for LOTR api"
+  spec.homepage      = "https://rubygems.org/gems/derek_hall-sdk"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dhall"
+  spec.metadata["changelog_uri"] = "https://github.com/dhall"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "http", "~> 5.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: derek_hall-sdk
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Derek Hall
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: SDK for LOTR api
+email:
+- derekhall77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- design.md
+- lib/lotr/sdk.rb
+- lib/lotr/sdk/client.rb
+- lib/lotr/sdk/dataset.rb
+- lib/lotr/sdk/version.rb
+- lotr-sdk.gemspec
+homepage: https://rubygems.org/gems/derek_hall-sdk
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/derek_hall-sdk
+  source_code_uri: https://github.com/dhall
+  changelog_uri: https://github.com/dhall
+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: SDK for LOTR api
+test_files: []