pdga_api 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5432a78e98dc550da5350ece5c4d2b451c971c3d1c3beb9f212b6873aee7a4
-  data.tar.gz: '0935e3fee69e705e06a09e8ad0aad8ef99d2c9181e55b192f2fe251b3f0e4bb9'
+  metadata.gz: 35b7df8255cda304c73b1b758e8bfdae890255ccff47048e5064819588d39a66
+  data.tar.gz: 61ffb3de12198b1662e8af6c2acc91e92106b65ce8de717917db9589a55e3377
 SHA512:
-  metadata.gz: fe7fb83b60d7209f1c8d51cdf257baad529536acee747d2d938d6a3356837715e78ba91fa04760929585e322d4906ab6043b629cee6f34c3c7d4280654b21ea5
-  data.tar.gz: f1df1098a4fa046e02322a3f535efe16a0fe4717efa0b30a1478d8a8beb2f6f540c6aba3587a3c189165081e97078125e4d9345e2a402523bea542aabbbf7444
+  metadata.gz: 0d6e0500248d9fb1f00dab716e2b9932afe8d6118cecadffa2ba531b62eb7fa4acdd9b59e1243d3f4eb4eb56a8cc1706b4db912b7fb6cfe1ff23a7a8e2e82d8c
+  data.tar.gz: 273e1b051f53b6f86e33d7422e7baec267549a4f98f0ff4ad8b1ca05672d50204b0764673946170f6c061bed9a4b07811be39ea03925f9b30a561d585ce09832

data/.gitignore

@@ -5,6 +5,4 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
-/secret.env
-/pdga_api.env
+/tmp/

data/README.md

@@ -18,9 +18,7 @@ Or install it yourself as:
     $ gem install pdga_api
 ## Starting steps
 
-Out of the box there are some ENV vars that are needed in order to make this gem work (also assumes you already have PDGA API access)
-First in the root directory there are 2 template .env files you can look at for setting up the ENV vars. You can run this with just a secret.env that contains your PDGA username and password
-If you run the login method it will write out a .env with additional information the API needs to make calls. (session id, session name, and token)
+In order to use this you will need to initialize using your pdga username and password
 
 ## Usage
 
@@ -28,16 +26,16 @@ Expected responses can all be found here https://www.pdga.com/dev/api/rest/v1/au
 
 There are 4 types of actions that this gem allows you to perform.
 1. Authentication
-   1. login Pdga::Client.login({ username: ENV["USERNAME"], password: ENV["PASSWORD"] }) (Could pass the actual username/password)
-   2. connection status Pdga::Client.connect
-   3. logout Pdga::Client.logout
+   1. Initialize `@client = Pdga.new(username: "username goes here", password: "password goes here")`
+   2. connection status `@client.connect`
+   3. logout `@client.logout`
 2. Player information which takes a hash of various search params that are listed on the PDGA site (default 10 returned with a max of 200)
-   1. player search Pdga::Client.players({ pdga_number: "15857" })
-   2. player statistics search Pdga::Client.player_statistics({ pdga_number: "15857", year: "2022" })
+   1. player search `@client.players({ pdga_number: "15857" })`
+   2. player statistics search `@client.player_statistics({ pdga_number: "15857", year: "2022" })`
 3. Event information which takes a hash of various search params that are listed on the PDGA site (default 10 returned with a max of 200)
-   1. event search Pdga::Client.events({ tournament_id: "47877" })
+   1. event search `@client.events({ tournament_id: "47877" })`
 4. Course information which takes a hash of various search params that are listed on the PDGA site (default 10 returned with a max of 200)
-   1. course search Pdga::Client.courses({ course_id: "2146" })
+   1. course search `@client.courses({ course_id: "2146" })`
 
 ## License
 
@@ -50,6 +48,4 @@ Everyone interacting in the PdgaApi project's codebases, issue trackers, chat ro
 ## Todos
 
 1. Mock the tests!
-2. Figure out something better for the ENV vars
-3. Add response error handling from the API
-4. Refactor duplicated code in client.rb
+2. Make readme pretty and thorough

data/lib/pdga_api/api/auth.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdga
+  module Auth
+    def login(options)
+      response = build_request("post", "services/json/user/login", options)
+      save_session_information(response)
+      response
+    end
+
+    def connect
+      build_request("post", "services/json/system/connect")
+    end
+
+    def logout
+      build_request("post", "services/json/user/logout")
+    end
+  end
+end

data/lib/pdga_api/api/course.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pdga
+  module Course
+    def courses(options)
+      build_request("get", "services/json/course?#{build_params(options)}")
+    end
+  end
+end

data/lib/pdga_api/api/event.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pdga
+  module Event
+    def events(options)
+      build_request("get", "services/json/event?#{build_params(options)}")
+    end
+  end
+end

data/lib/pdga_api/api/player.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdga
+  module Player
+    def players(options)
+      build_request("get", "services/json/players?#{build_params(options)}")
+    end
+
+    def player_statistics(options)
+      build_request("get", "services/json/player-statistics?#{build_params(options)}")
+    end
+  end
+end

data/lib/pdga_api/api/request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pdga
+  module Request
+    API_ENDPOINT = "https://api.pdga.com"
+    attr_accessor :sessid, :session_name, :token
+
+    protected
+
+    def client
+      Faraday.new(API_ENDPOINT) do |client|
+        client.use Faraday::Response::RaiseError
+        client.request :url_encoded
+        client.adapter Faraday.default_adapter
+        client.headers["Cookie"] = "#{@session_name}=#{@sessid}"
+        client.headers["X-CSRF-Token"] = @token
+      end
+    end
+
+    def request(http_method:, endpoint:, body: {})
+      client.public_send(http_method, endpoint, body)
+    end
+
+    def build_params(options)
+      params = ""
+      options.each do |key, value|
+        params += "#{key}=#{value}&"
+      end
+      params.chomp!("&")
+    end
+
+    def build_request(http_method, endpoint, options = {})
+      JSON.parse(request(
+        http_method: http_method.to_sym,
+        endpoint: endpoint,
+        body: options
+      ).body)
+    end
+
+    def save_session_information(login_response)
+      @sessid = login_response["sessid"]
+      @session_name = login_response["session_name"]
+      @token = login_response["token"]
+    end
+  end
+end

data/lib/pdga_api/client.rb

@@ -4,90 +4,29 @@ require "faraday"
 require "json"
 require "oj"
 require "dotenv"
+require "pdga_api/api/auth"
+require "pdga_api/api/request"
+require "pdga_api/api/course"
+require "pdga_api/api/player"
+require "pdga_api/api/event"
 
 module Pdga
   # API Client for PDGA
   class Client
-    API_ENDPOINT = "https://api.pdga.com"
+    attr_accessor :username, :password, :sessid, :session_name, :token
+    include Pdga::Auth
+    include Pdga::Request
+    include Pdga::Course
+    include Pdga::Player
+    include Pdga::Event
 
-    def self.players(options)
-      params = build_params(options)
-      response = build_request("get", "services/json/players?#{params}")
-      JSON.parse(response.body)
-    end
-
-    def self.player_statistics(options)
-      params = build_params(options)
-      response = build_request("get", "services/json/player-statistics?#{params}")
-      JSON.parse(response.body)
-    end
-
-    def self.events(options)
-      params = build_params(options)
-      response = build_request("get", "services/json/event?#{params}")
-      JSON.parse(response.body)
-    end
-
-    def self.courses(options)
-      params = build_params(options)
-      response = build_request("get", "services/json/course?#{params}")
-      JSON.parse(response.body)
-    end
-
-    def self.login(options)
-      response = build_request("post", "services/json/user/login", options)
-      update_envs(JSON.parse(response.body))
-      JSON.parse(response.body)
-    end
-
-    def self.connect
-      response = build_request("post", "services/json/system/connect")
-      JSON.parse(response.body)
-    end
-
-    def self.logout
-      response = build_request("post", "services/json/user/logout")
-      clear_env
-      JSON.parse(response.body)
-    end
-
-    def self.client
-      @client ||= Faraday.new(API_ENDPOINT) do |client|
-        client.use Faraday::Response::RaiseError
-        client.request :url_encoded
-        client.adapter Faraday.default_adapter
-        client.headers["Cookie"] = "#{ENV["SESSION_NAME"]}=#{ENV["SESSID"]}"
-        client.headers["X-CSRF-Token"] = ENV["TOKEN"]
-      end
-    end
+    def initialize(options = {})
+      raise(ArgumentError, "username and password are required parameters") unless options.key?(:username) && options.key?(:password)
 
-    def self.request(http_method:, endpoint:, body: {})
-      client.public_send(http_method, endpoint, body)
-    end
-
-    def self.build_params(options)
-      params = ""
-      options.each do |key, value|
-        params += "#{key}=#{value}&"
-      end
-      params.chomp!("&")
-    end
-
-    def self.build_request(http_method, endpoint, options = {})
-      request(
-        http_method: http_method.to_sym,
-        endpoint: endpoint,
-        body: options
-      )
-    end
+      @username = options[:username]
+      @password = options[:password]
 
-    def self.update_envs(response)
-      f = File.new("pdga_api.env", "w")
-      f.write("SESSID=#{response["sessid"]}\nSESSION_NAME=#{response["session_name"]}\nTOKEN=#{response["token"]}")
-      f.close
-      ENV["SESSID"] = response["sessid"]
-      ENV["SESSION_NAME"] = response["session_name"]
-      ENV["TOKEN"] = response["token"]
+      login(username: @username, password: @password)
     end
   end
 end

data/lib/pdga_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PdgaApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/pdga_api.rb

@@ -4,8 +4,30 @@ require_relative "pdga_api/version"
 require_relative "pdga_api/client"
 require "dotenv"
 
-module PdgaApi
-  class Error < StandardError; end
-  # Your code goes here...
-  Dotenv.load("pdga_api.env", "secret.env")
+module Pdga
+  class << self
+    attr_accessor :options
+  end
+  self.options = {}
+
+  def self.new(params = {})
+    Pdga::Client.new(params)
+  end
+
+  def self.configure(params = {})
+    raise(ArgumentError, "username and password are required parameters") unless params.key?(:username) && params.key?(:password)
+
+    options[:username] = params[:username]
+    options[:password] = params[:password]
+
+    login(username: @username, password: @password)
+  end
+
+  def self.config
+    options
+  end
+
+  def self.reset_config
+    self.options = {}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdga_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Robert Elia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -125,11 +125,14 @@ files:
 - bin/console
 - bin/setup
 - lib/pdga_api.rb
+- lib/pdga_api/api/auth.rb
+- lib/pdga_api/api/course.rb
+- lib/pdga_api/api/event.rb
+- lib/pdga_api/api/player.rb
+- lib/pdga_api/api/request.rb
 - lib/pdga_api/client.rb
 - lib/pdga_api/version.rb
-- pdga_api.env.template
 - pdga_api.gemspec
-- secret.env.template
 homepage: https://github.com/relia1/pdga_api
 licenses:
 - MIT

data/pdga_api.env.template

@@ -1,3 +0,0 @@
-SESSID=SESSID
-SESSION_NAME=SESSION_NAME
-TOKEN=TOKEN

data/secret.env.template

@@ -1,2 +0,0 @@
-USERNAME=USERNAME
-PASSWORD=PASSWORD