fuelscropt-api-client 0.3.2 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb541aa0e46ccb5b7d0e0de3cfcd456e32005657500f7920ea9cec2f46b01f3a
-  data.tar.gz: 5da5660467e0674cfd6cb1a6eea8c1d4db2165217a859aa1c7e358120f9f85d2
+  metadata.gz: a34f279a374fd26ada79b520b53fcf06db351b6e444e3f9b8056dd2fd041c674
+  data.tar.gz: fe31fd6dbaa23131305d95b050c5bf968fb24249882fd47905a2f58502fdef29
 SHA512:
-  metadata.gz: 50e5c99360e1cd199469d793ef879043ca45963e29494fe5b7fe179438b66164be5c4f0070396f8c678b541c8a9d5b8e96e3dc0cf20d6553968ad3f8f95509ad
-  data.tar.gz: '0389a43fc2515155689e33fd376014b4838ad7a8864ea9b17ec6d98a898d99ca5afbf5db0d6c4e54ef010744e868e6ecf891cdcefb69f65f1928d02e397bd92c'
+  metadata.gz: bd7e23d56034273edcf0a4eee3f993fed69bec4f61a104137a6ec3ae5a096b1f7de5a338dc87cef33d3092a6035139068e5cb2d7ce77e34ce2b9c2b21d4f43b7
+  data.tar.gz: 928563ca037edbff7d224ad9d6e92d2492a5307f9fa50bdef213564da22a816340558fed40404171ae280a27a1d0b11f83b4e0b45bc64d95647a3f95d9c6cda1

data/.gitignore

@@ -13,3 +13,6 @@
 /demo
 *.gem
 *.gemspec
+
+# don't include our openapi spec
+# openapi.json

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fullscriptapi (0.2.0)
+    fuelscropt-api-client (0.3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -28,7 +28,7 @@ PLATFORMS
 
 DEPENDENCIES
   excon (~> 0.85.0)
-  fullscriptapi!
+  fuelscropt-api-client!
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # Fullscriptapi
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fullscriptapi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Are you building to Fuelscropt's API and is your stack in `ruby`? If so, here's a gem for you.
 
 ## Installation
 
@@ -22,7 +20,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Initialize your client with
+
+``` ruby
+client = Fullscriptapi.config do |c|
+  c.client_id = "your_client_id" # obtain it from the api dashboard
+  c.secret = "your_client_secret" # obtain it from the api dashboard
+  c.redirect_uri = "your_apps_redirect_uri" # obtain it from the api dashboard
+  c.server = "dev" # choose one of us_prod, us_snd, ca_prod, ca_snd, dev
+end
+```
+
+Next provide a token hash for your client like this
+
+``` ruby
+client.use_token(
+  access_token: "access_token",
+  refresh_token: "refresh_token",
+  expires_in: 7200
+)
+```
+
+Then you're ready to make non-authentication api calls (api calls not related to obtaining/refreshing/revoking a token) like this:
+
+``` ruby
+client.list_all_products
+client.create_an_oauth_token(grant) #you'll need your auth grant for this
+```
+
+The method names on the `client` match the snake case version of the headings in the fuelscropt api documentation.
+
+For example, the `List all Patients` heading will translate to `client.list_all_patients`.
+
+For endpoints that take an `id` parameter (could be `practitioner_id`, `patient_id`, etc) pass that `id` as a required parameter in a nested `query` hash to the api call. This
+
+Example:
+
+``` ruby
+client.retrieve_a_patient(query: { id: "patient_id" })
+```
+
+For endpoints that require a `body` passed in, pass that `body` as a required parameter to the api call.
+
+Example:
+
+``` ruby
+client.create_a_patient(
+  body: {
+    first_name: "Testing",
+    last_name: "MyGem",
+    email: "test@mygem.com"
+  }
+)
+```
 
 ## Development
 

data/lib/fullscriptapi/{endpoints → authentication_endpoints}/create_an_oauth_token.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 module Fullscriptapi
-  module Endpoints
+  module AuthenticationEndpoints
     module CreateAnOauthToken
+      module_function
+
       def create_an_oauth_token(grant)
         # you need to have an auth grant to use this method
   
         raise unless client_id && secret && redirect_uri
   
-        response = Excon.post("#{get_server}/oauth/token",
+        response = Excon.post("#{get_server}/api/oauth/token",
           headers: {
             "Content-Type": "application/json"
           },

data/lib/fullscriptapi/{endpoints → authentication_endpoints}/refresh_token.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Fullscriptapi
-  module Endpoints
+  module AuthenticationEndpoints
     module RefreshToken
       def refresh_token
-        response = Excon.post("#{get_server}/oauth/token",
+        response = Excon.post("#{get_server}/api/oauth/token",
           headers: {
             "Content-Type": "application/json"
           },
@@ -19,7 +19,6 @@ module Fullscriptapi
   
         body = JSON.parse(response.body)
   
-        pp body
         use_token(body["oauth"])
       end
     end

data/lib/fullscriptapi/authentication_endpoints.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'authentication_endpoints/create_an_oauth_token'
+require_relative 'authentication_endpoints/refresh_token'
+
+module Fullscriptapi
+  module AuthenticationEndpoints
+    include CreateAnOauthToken
+    include RefreshToken
+  end
+end

data/lib/fullscriptapi/servers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Fullscriptapi
+  module Servers
+    SERVERS = {
+      "dev" => "http://localhost:3000",
+      "us_snd" => "https://api-us-snd.fullscript.io",
+      "ca_snd" => "https://api-ca-snd.fullscript.io",
+      "us_prod" => "https://api-us.fullscript.io",
+      "ca_prod" => "https://api-ca.fullscript.io"
+    }.freeze
+
+    def get_server
+      SERVERS["#{server}"]
+    end
+  end
+end

data/lib/fullscriptapi/version.rb

@@ -1,3 +1,3 @@
 module Fullscriptapi
-  VERSION = "0.3.2"
+  VERSION = "0.3.5"
 end

data/lib/fullscriptapi.rb

@@ -1,12 +1,14 @@
 require_relative "fullscriptapi/version"
 require_relative "fullscriptapi/access_token"
-require_relative "fullscriptapi/endpoints"
+require_relative "fullscriptapi/authentication_endpoints"
+require_relative "fullscriptapi/servers.rb"
 require 'excon'
 require 'json'
 
 module Fullscriptapi
   class << self
-    include Fullscriptapi::Endpoints
+    include Fullscriptapi::AuthenticationEndpoints
+    include Fullscriptapi::Servers
 
     attr_accessor :client_id, :secret, :redirect_uri, :token, :server
 
@@ -22,23 +24,74 @@ module Fullscriptapi
       @token = Fullscriptapi::AccessToken.new(opts)
     end
 
-    private      
-      def get_server
-        servers["#{server}"]
-      end
+    def method_missing(name, *args, &block)
+      @requested_method_hash = api_json_meta.detect { |v| v[:api_method] == name.to_s }
+      
+      super unless requested_method_hash
 
-      def servers
-        {
-          "dev" => "http://localhost:3000/api",
-          "us_snd" => "https://api-us-snd.fullscript.io/api/",
-          "ca_snd" => "https://api-ca-snd.fullscript.io/api/",
-          "us_prod" => "https://api-us.fullscript.io/api/",
-          "ca_prod" => "https://api-ca.fullscript.io/api/"
-        }
-      end
+      refresh_token if stale_token? # TO-DO: write logic to improve token refresh
+
+      params = excon_params(*args)
+      
+      Excon.send(*params)
+    end
+
+    private
+      attr_reader :requested_method_hash
 
       def stale_token?
         token && token.expired?
       end
+
+      def openapi_json
+        @_openapi_json ||=
+        JSON.parse(File.read(File.join(File.dirname(__FILE__), '../openapi.json')))["paths"]
+      end
+
+      def api_json_meta
+        @_api_json_meta ||= begin
+          available_methods = []
+          openapi_json.each do |key, value|
+            http_methods = value.keys
+
+            http_methods.each do |method|
+              api_method = value[method.to_s]["summary"].downcase.gsub(" ", "_")
+              hash_to_add = {
+                api_method: api_method,
+                http_method: method,
+                path: key
+              }
+              available_methods << hash_to_add # [ { api_method: "create_a_patient, http_method: "post", path: "api/clinic/patients" }, ... ]
+            end
+          end
+          available_methods
+        end
+      end
+
+      def excon_params(*args)
+        path, http_method, api_method = requested_method_hash.values_at(:path, :http_method, :api_method)
+        args_hash = args.first
+        first_bracket = path.index('{')
+        second_bracket = path.index('}')
+
+        path_dup = path.dup
+        if args_hash.is_a?(Hash) && args_hash[:query]
+          path_dup[first_bracket..second_bracket] = args_hash[:query][:id] if args_hash[:query][:id] && first_bracket && second_bracket
+          path_dup += "?query=#{args_hash[:query][:search]}" if args_hash[:query][:search]
+        end
+
+        url = "#{get_server}#{path_dup}"
+
+        params = {
+          headers: {
+            "Content-Type": "application/json",
+            "Authorization": "Bearer #{token.access_token}"
+          }
+        }
+
+        params.merge!(body: args_hash[:body].to_json) if args_hash.is_a?(Hash) && args_hash[:body] && args_hash[:body].is_a?(Hash)
+
+        return http_method.to_sym, url, params
+      end
   end
 end