shyftplan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f23944868ffa1c4dece4e0c82d639f4b0aaf0ee90ebcdaef42df53d0b72a9db
+  data.tar.gz: aa143c295b5d78b8374ad46039e3c2e9e34b10c8447a0a52443a1cd25f3d02fc
+SHA512:
+  metadata.gz: 109ac9a53bb546bb6293ffc330cfa5bbdd30915d8c77318c839c91b9aad30da01887f284a6d3d5147481cb3a2093f251c73f1e6f3e80aef0b340b223566fbdfd
+  data.tar.gz: 117457bce38c2b53cf8d172256c8912aa085d6a07fd480ce8cd9cfc1df20b134d251eafe033c0da79f247c443a9e36ed3a1089403de0b5ec6466534994b8a320

data/README.md

@@ -0,0 +1,55 @@
+# shyftplan-ruby
+
+Ruby gem for Shyftplan's REST API https://github.com/shyftplan/api-documentation
+
+Try the gem on repl.it https://replit.com/@nisanth074/tryshyftplanruby#main.rb
+
+## Installation
+
+Add the gem to your Rails app's Gemfile
+
+```ruby
+gem "shyftplan", git: "https://github.com/nisanth074/shyftplan-ruby", branch: "main"
+```
+
+and bundle install
+
+```bash
+bundle install
+```
+
+## Usage
+
+Initialize the Shyftplan client
+
+```ruby
+shyftplan = Shyftplan.new("john@acme.com", "dummy_api_token")
+```
+
+Retrieve evaluations
+
+```ruby
+response = shyftplan.get("/evaluations")
+evaluations = response["items"]
+```
+
+Retrieve evaluations across all pages
+
+```ruby
+evaluations = shyftplan.each_page("/evaluations")
+```
+
+Doing the above may take a while. If you'd like to perform any action after each page retrieval, provide a block
+
+```ruby
+shyftplan.each_page("/evaluations") do |page|
+  puts "Page retrieved..."
+
+  evaluations = page["items"]
+  EvaluationsCSVExport.add(evaluations)
+end
+```
+
+## Todos
+
+- Publish gem to https://rubygems.org

data/lib/shyftplan/errors.rb

@@ -0,0 +1,11 @@
+class Shyftplan
+  module Errors
+    class UnsuccessfulResponse < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+    end
+  end
+end

data/lib/shyftplan/page.rb

@@ -0,0 +1,13 @@
+class Page
+  class << self
+    def retrieve(*args)
+    end
+  end
+
+  def initialize(shyftplan, path, page_number, per_page, options = {})
+    @shyftplan = shyftplan
+  end
+
+  def retrieve
+  end
+end

data/lib/shyftplan/version.rb

@@ -0,0 +1,3 @@
+class Shyftplan
+  VERSION = "0.1.0"
+end

data/lib/shyftplan.rb

@@ -0,0 +1,92 @@
+require "httparty"
+require_relative "./shyftplan/version"
+require_relative "./shyftplan/errors"
+
+class Shyftplan
+  attr_reader :site,
+              :user_email,
+              :authentication_token
+
+  def initialize(*args)
+    if args.size == 3
+      @site, @user_email, @authentication_token = args
+    else
+      @site = "https://shyftplan.com"
+      @user_email, @authentication_token = args
+    end
+  end
+
+  def base_url
+    site + "/api/v1"
+  end
+
+  [:get, :post, :put, :delete].each do |http_method|
+    define_method(http_method) do |*args|
+      request(http_method, *args)
+    end
+  end
+
+  # Retrieve items across all pages
+  # @example
+  #   Shyftplan.each_page("/shifts")
+  #
+  # @example Perform an action after each page retrieval
+  #   Shyftplan.each_page("/shifts") { |page| puts "Page retrieved..." }
+  def each_page(path, options = {})
+    page = 1
+    items = []
+    loop do
+      options[:query] = if options[:query]
+        options[:query].merge(page:)
+      else
+        {
+          page:,
+        }
+      end
+      response = get(path, options)
+      yield response if block_given?
+      page = page + 1
+      items = items + response["items"]
+      break if items.size >= response["total"]
+    end
+
+    items
+  end
+
+  private
+
+  def request(http_method, path, options = {})
+    url = base_url + path
+    httparty_options = default_httparty_options
+    httparty_options[:query].merge!(options[:query]) if options[:query]
+    if options[:body]
+      httparty_options[:body] = if options[:body].is_a?(String)
+        options[:body]
+      else
+        options[:body].to_json
+      end
+      httparty_options[:headers]["Content-Type"] = "application/json"
+    end
+    response = HTTParty.public_send(http_method, url, httparty_options)
+    raise Shyftplan::Errors::UnsuccessfulResponse.new(response) unless response.success?
+    response
+  end
+
+  def default_httparty_options
+    {
+      headers: default_headers,
+      query: authentication_params
+    }
+  end
+
+  def authentication_params
+    {
+      user_email:,
+      authentication_token:
+    }
+  end
+
+  def default_headers
+    { "Accept" => "application/json" }
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: shyftplan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nisanth Chunduru
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem for Shyftplan's REST API
+email:
+- nisanth074@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shyftplan.rb
+- lib/shyftplan/errors.rb
+- lib/shyftplan/page.rb
+- lib/shyftplan/version.rb
+homepage: https://github.com/nisanth074/shyftplan-ruby
+licenses: []
+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: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Ruby gem for Shyftplan's REST API
+test_files: []