igdb_client 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a70dde7eec9c2dcd49f0d78d45e276da1d82d7b92b75f70de72a8ba15c924fde
+  data.tar.gz: f6b0fca3ff708727484dfe3e681d623a8bce7ee552e791c0b1e8b5e822898b01
+SHA512:
+  metadata.gz: ab20081e602219067565591de03b7094161f136bcc3b41c6621430eb27e08a7ae3881b19ebfe1c24447c228103cbb9600f55583ba4d2a32888c0dfb23e0ef2d8
+  data.tar.gz: 2be9be28b1fdac117d86417d5e7a13bd43431b08185317bd0987cfb2bf1965fdea81bf93328c94eda6908681a2116c19c596dd945812bf1f364a05cb7efb206a

data/README.md

@@ -0,0 +1,56 @@
+# igdb_client
+Ruby client interface for IGDB API
+
+## Usage
+The client can be used in one of two ways. Either as an instance or a class.
+They work pretty much in the same manner.
+
+The structure of queries and results matches the [api documentaion.](https://igdb.github.io/api/)
+
+##### Instance
+```ruby
+# initialize with api_key
+client = IGDB::Client.new "api_key"
+
+# methods match IGDB api endpoints, pass an optional hash as query params
+client.games 1942, {fields: "name"}
+
+# pass multiple ids in an array
+client.games [1942,3344], {fields: "name,release_dates,esrb.synopsis,rating"}
+
+# to run a text search on a resource, put search_ before resource name
+client.search_games "ibb and obb"
+
+# to count number of resources matched, put count_ before resource name
+client.count_games {"filter[rating][gt]" => 75}
+
+# Access retrieved data by using methods matching fields of data
+results = client.platform 2
+results[0].name
+results[0].summary
+```
+
+
+
+##### Class Methods
+```ruby
+# initialize with api_key
+IGDB::API.api_key = "api_key"
+
+# methods match IGDB api endpoints, pass an optional hash as query params
+IGDB::API.games 1942, {fields: "name"}
+
+# pass multiple ids in an array
+IGDB::API.games [1942,3344], {fields: "name,release_dates,esrb.synopsis,rating"}
+
+# to run a text search on a resource, put search_ before resource name
+IGDB::API.search_games "ibb and obb"
+
+# to count number of resources matched, put count_ before resource name
+IGDB::API.count_games {"filter[rating][gt]" => 75}
+
+# Access retrieved data by using methods matching fields of data
+results = IGDB::API.platform 2
+results[0].name
+results[0].summary
+```

data/lib/igdb/api.rb

@@ -0,0 +1,11 @@
+require 'igdb/connection'
+
+module IGDB
+   class API
+      extend IGDB::Connection
+
+      class << self
+         attr_accessor :api_key
+      end
+   end
+end

data/lib/igdb/client.rb

@@ -0,0 +1,14 @@
+require 'igdb/connection'
+
+module IGDB
+   class Client
+      include IGDB::Connection
+
+      attr_accessor :api_key
+
+      def initialize(api_key)
+         @api_key = api_key
+      end
+
+   end
+end

data/lib/igdb/connection.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+module IGDB
+   module Connection
+      URL = "https://api-endpoint.igdb.com/"
+      HEADER = {"Accept" => "application/json"}
+      HEADER_API_KEY_PARAM = "user-key"
+
+      def get path, ids=nil, params={}
+         uri = URI.parse(URL)
+         http = Net::HTTP.new(uri.host, uri.port)
+         http.use_ssl = true
+         path_base = "/" + path + "/"
+         path_id = ids.join(',') if ids.kind_of?(Array)
+         path_id ||= ids.to_s
+         path_params = URI.encode_www_form(params)
+         full_path = path_base + path_id
+         full_path << "?" + path_params unless path_params.empty?
+         req = Net::HTTP::Get.new full_path, HEADER.merge({HEADER_API_KEY_PARAM => self.api_key})
+         response = http.request(req)
+         response.value
+         JSON.parse response.body ,object_class: OpenStruct
+      end
+
+      def method_missing(m, *args, opts, &block)
+         method = m.to_s
+         if method[/^search_/]
+            method[/^search_/] = ""
+            # If only single string argument passed in args becomes empty
+            # and string lands in opts
+            if args.empty?
+               args = [opts]
+               opts = {}
+            end
+            params = {"search" => args.first}
+            params = params.merge(opts) if opts
+            self.get method, nil, params
+         elsif method[/^count_/]
+            method[/^count_/] = ""
+            self.get method, "count", opts
+         else
+            self.get method, args, opts
+         end
+      end
+
+   end
+end

data/lib/igdb_client.rb

@@ -0,0 +1,2 @@
+require 'igdb/api'
+require 'igdb/client'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: igdb_client
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Abdulla Bubshait
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies: []
+description: A Client for the Internet Game Database
+email:
+- darkstego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/igdb/api.rb
+- lib/igdb/client.rb
+- lib/igdb/connection.rb
+- lib/igdb_client.rb
+homepage: https://github.com/darkstego/igdb_client
+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.7.5
+signing_key: 
+specification_version: 4
+summary: Ruby IGDB API.
+test_files: []