swapir 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18c95e1ca571300b653917f602650125b7e54a6b
+  data.tar.gz: e4881bda1b9697b3e0d95633c6469d462e5d2655
+SHA512:
+  metadata.gz: c84db503a2f972d766193f9e73551a1e3c6752be15d86ce2a9610465d0f1a560e7a310589af52b6b90d96bf7ab80b91f577607723d177ee3c046cd2b66ea44df
+  data.tar.gz: 6a9e30478c1d333338191636b170ee3117153b164aaf4357bb672bd1149eb634e78304d81a9eced7866a5a054ff8fdb25f72a2040b1b7db01ae7e9f1431bbd38

data/Gemfile

@@ -0,0 +1,12 @@
+# manage the gem dependencies with bundler
+source "https://rubygems.org"
+
+# gem dependencies in swapir.gemspec
+gemspec :name => "swapir"
+
+gem "rest-client"
+gem "json"
+
+group :development do
+	gem "byebug"
+end

data/lib/swapir/resource_api.rb

@@ -0,0 +1,27 @@
+## Query the Star Wars Api for the details of a specific resource
+#
+require "swapir/swapi_resources"
+
+module ResourceApi
+  def self.included(klass)
+    # 'included' callback adds the ClassMethods module methods
+    # as class methods to the calling class
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    STAR_WARS_API_RESOURCES.each do |resource|
+      resource_name = case resource
+        when "people" then "person"
+        when "species" then resource
+        else resource.slice(0...-1)
+      end
+
+      # define_method creates a closure which can hold references
+      # to large objects that will never be garbage collected
+      define_method("find_#{resource_name}") do |id|
+        decode(request("#{resource}/#{id}/"))
+      end
+    end
+  end
+end

data/lib/swapir/resource_list_api.rb

@@ -0,0 +1,21 @@
+## Retrieve a collection of resources from the Star Wars Api
+#
+require "swapir/swapi_resources"
+
+module ResourceListApi
+  def self.included(klass)
+    # 'included' callback adds the ClassMethods module methods
+    # as class methods to the calling class
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    STAR_WARS_API_RESOURCES.each do |resource|
+      # define_method creates a closure which can hold references
+      # to large objects that will never be garbage collected
+      define_method("get_all_#{resource}") do
+        decode_results(request(resource))
+      end
+    end
+  end
+end

data/lib/swapir/resource_search_api.rb

@@ -0,0 +1,21 @@
+## Search the Star Wars Api for a resource
+#
+require "swapir/swapi_resources"
+
+module ResourceSearchApi
+  def self.included(klass)
+    # 'included' callback adds the ClassMethods module methods
+    # as class methods to the calling class
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    STAR_WARS_API_RESOURCES.each do |resource|
+      # define_method creates a closure which can hold references
+      # to large objects that will never be garbage collected
+      define_method("search_#{resource}") do |query|
+        decode_results(request("#{resource}/?search=#{query}"))
+      end
+    end
+  end
+end

data/lib/swapir/swapi_resources.rb

@@ -0,0 +1 @@
+STAR_WARS_API_RESOURCES = %w(films people planets species starships vehicles)

data/lib/swapir.rb

@@ -0,0 +1,49 @@
+## Star Wars API Request Service
+# resources: people, planets, species, starships, and vehicles
+# actions: list, find by id, and search by resource
+#
+
+# external gem dependencies
+require "rest-client"
+require "json"
+require "byebug"
+
+# internal dependencies
+require "swapir/resource_api"
+require "swapir/resource_list_api"
+require "swapir/resource_search_api"
+
+class Swapir
+  include ResourceListApi
+  include ResourceApi
+  include ResourceSearchApi
+
+  def self.api_base_url
+    # base Star Wars public api url
+    "http://swapi.co/api/"
+  end
+
+  def self.api_available?
+    # allow an exception to be raised if the request fails
+    # handle the raised exception
+    RestClient.get(api_base_url).code == 200
+  end
+
+  def self.request(resource)
+    # call the Star Wars Api endpoint
+    # returns the api response
+    RestClient.get(api_base_url + resource)
+  end
+
+  def self.decode(response)
+    # convert the Star Wars Api response body
+    # return the data in a Ruby Hash
+    JSON.parse(response.body)
+  end
+
+  def self.decode_results(response)
+    # convert the Star Wars Api response body collection
+    # return the data collection in a Ruby Hash
+    JSON.parse(response.body)["results"]
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: swapir
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Riana Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A wrapper gem that handles interactions with the Star Wars Api
+email:
+- rianaferreira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/swapir.rb
+- lib/swapir/resource_api.rb
+- lib/swapir/resource_list_api.rb
+- lib/swapir/resource_search_api.rb
+- lib/swapir/swapi_resources.rb
+homepage: https://github.com/RianaFerreira/swapir
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Star Wars Api wrapper
+test_files: []