wcc_ministries_client 1.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+=begin
+#WCC Ministries API
+
+#WCC Ministries API
+
+The version of the OpenAPI document: 1.0.0
+Contact: dev@watermark.org
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+# load the gem
+require 'wcc_ministries_client'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/swagger.json

@@ -0,0 +1,425 @@
+{
+  "openapi" : "3.0.0",
+  "info" : {
+    "description" : "WCC Ministries API",
+    "version" : "1.0.0",
+    "title" : "WCC Ministries API",
+    "contact" : {
+      "email" : "dev@watermark.org"
+    },
+    "license" : {
+      "name" : "Apache 2.0",
+      "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+    }
+  },
+  "servers" : [ {
+    "description" : "Watermark.org production server",
+    "url" : "https://www.watermark.org/api/v1/ministries"
+  } ],
+  "tags" : [ {
+    "name" : "ministry",
+    "description" : "Endpoints to get Ministry entities"
+  } ],
+  "paths" : {
+    "/" : {
+      "get" : {
+        "tags" : [ "ministry" ],
+        "summary" : "Query for a list of ministries matching some criteria",
+        "operationId" : "listMinistries",
+        "description" : "Search for ministries by some query parameters\n",
+        "parameters" : [ {
+          "in" : "query",
+          "name" : "filter[slug]",
+          "description" : "Match a single ministry by unique slug",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "in" : "query",
+          "name" : "skip",
+          "description" : "Number of records to skip for pagination",
+          "required" : false,
+          "schema" : {
+            "type" : "integer"
+          }
+        }, {
+          "in" : "query",
+          "name" : "limit",
+          "description" : "Number of records to return in this page",
+          "required" : false,
+          "schema" : {
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/MinistryListResponse"
+          },
+          "400" : {
+            "description" : "bad input parameter"
+          }
+        }
+      }
+    },
+    "/{id}" : {
+      "get" : {
+        "tags" : [ "ministry" ],
+        "summary" : "Get a single ministry by ID",
+        "operationId" : "getMinistry",
+        "parameters" : [ {
+          "in" : "path",
+          "name" : "id",
+          "description" : "The UUID of the ministry",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/MinistryShowResponse"
+          },
+          "404" : {
+            "description" : "No ministry exists with that UUID"
+          }
+        }
+      }
+    }
+  },
+  "components" : {
+    "responses" : {
+      "MinistryShowResponse" : {
+        "description" : "A single ministry found by ID",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : "object",
+              "required" : [ "data" ],
+              "properties" : {
+                "data" : {
+                  "$ref" : "#/components/schemas/Ministry"
+                },
+                "included" : {
+                  "type" : "array",
+                  "items" : {
+                    "$ref" : "#/components/schemas/Page"
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "MinistryListResponse" : {
+        "description" : "A list of ministries with pagination metadata and links",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : "object",
+              "required" : [ "data", "meta", "links" ],
+              "properties" : {
+                "data" : {
+                  "type" : "array",
+                  "items" : {
+                    "$ref" : "#/components/schemas/Ministry"
+                  }
+                },
+                "meta" : {
+                  "type" : "object",
+                  "required" : [ "total", "limit", "skip" ],
+                  "properties" : {
+                    "total" : {
+                      "type" : "number",
+                      "description" : "The total number of ministries matching the query across all pages",
+                      "example" : 1
+                    },
+                    "limit" : {
+                      "type" : "number",
+                      "description" : "The page size",
+                      "example" : 10
+                    },
+                    "skip" : {
+                      "type" : "number",
+                      "description" : "The offset into the list at which this page starts",
+                      "example" : 0
+                    }
+                  }
+                },
+                "links" : {
+                  "type" : "object",
+                  "required" : [ "self", "first", "last" ],
+                  "properties" : {
+                    "self" : {
+                      "type" : "string",
+                      "description" : "A relative link to get this page of ministries again",
+                      "example" : "/api/v1/ministries?limit=10&skip=0"
+                    },
+                    "first" : {
+                      "type" : "string",
+                      "description" : "A relative link to get the first page",
+                      "example" : "/api/v1/ministries?limit=10&skip=0"
+                    },
+                    "prev" : {
+                      "type" : "string",
+                      "description" : "A relative link to get the previous page (null if this is the first page)",
+                      "example" : null
+                    },
+                    "next" : {
+                      "type" : "string",
+                      "description" : "A relative link to get the next page (null if this is the last page)",
+                      "example" : "/api/v1/ministries?limit=10&skip=10"
+                    },
+                    "last" : {
+                      "type" : "string",
+                      "description" : "A relative link to get the last page",
+                      "example" : "/api/v1/ministries?limit=10&skip=10"
+                    }
+                  }
+                },
+                "included" : {
+                  "type" : "array",
+                  "items" : {
+                    "$ref" : "#/components/schemas/Page"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "schemas" : {
+      "MinistryAttributes" : {
+        "type" : "object",
+        "required" : [ "code", "title", "descriptiveTitle" ],
+        "properties" : {
+          "code" : {
+            "type" : "string",
+            "example" : "re-generation"
+          },
+          "title" : {
+            "type" : "string",
+            "example" : "Re:Generation"
+          },
+          "descriptiveTitle" : {
+            "type" : "string",
+            "example" : "A biblically-based 12-step recovery program"
+          },
+          "displayInInternalSearch" : {
+            "type" : "boolean"
+          }
+        }
+      },
+      "Asset" : {
+        "type" : "object",
+        "required" : [ "title", "file" ],
+        "properties" : {
+          "title" : {
+            "type" : "string",
+            "example" : "Todd Wagner Square Profile Image"
+          },
+          "description" : {
+            "type" : "string",
+            "example" : "Todd Wagner"
+          },
+          "file" : {
+            "type" : "object",
+            "required" : [ "url" ],
+            "properties" : {
+              "url" : {
+                "type" : "string",
+                "example" : "//images.ctfassets.net/a/b/Todd-Wagner_2016__1_.jpg"
+              },
+              "fileName" : {
+                "type" : "string",
+                "example" : "Todd-Wagner_2016 (1).jpg"
+              },
+              "contentType" : {
+                "type" : "string",
+                "description" : "MIME type of image",
+                "example" : "image/jpeg"
+              },
+              "details" : {
+                "type" : "object",
+                "properties" : {
+                  "size" : {
+                    "type" : "number",
+                    "description" : "Size of file in bytes",
+                    "example" : 55406
+                  },
+                  "image" : {
+                    "type" : "object",
+                    "required" : [ "width", "height" ],
+                    "properties" : {
+                      "width" : {
+                        "type" : "number",
+                        "description" : "width of image in pixels",
+                        "example" : 700
+                      },
+                      "height" : {
+                        "type" : "number",
+                        "description" : "height of image in pixels",
+                        "example" : 700
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "Ministry" : {
+        "type" : "object",
+        "required" : [ "id", "type", "attributes", "relationships", "links", "meta" ],
+        "properties" : {
+          "id" : {
+            "type" : "string",
+            "description" : "The unique ID of the Ministry.  Used in the ministriesShow endpoint",
+            "example" : "7mUCKHxu0sve8ecXAFLJ21"
+          },
+          "type" : {
+            "type" : "string",
+            "description" : "Always the literal string 'ministry'.  This is used as a discriminator.",
+            "example" : "ministry",
+            "enum" : [ "ministry" ]
+          },
+          "attributes" : {
+            "$ref" : "#/components/schemas/MinistryAttributes"
+          },
+          "relationships" : {
+            "type" : "object",
+            "properties" : {
+              "homepage" : {
+                "$ref" : "#/components/schemas/PageRelationship"
+              }
+            }
+          },
+          "links" : {
+            "type" : "object",
+            "required" : [ "self" ],
+            "properties" : {
+              "self" : {
+                "type" : "string",
+                "description" : "A relative link to get this JSON from the API",
+                "example" : "/api/v1/ministries/7mUCKHxu0sve8ecXAFLJ21"
+              }
+            }
+          },
+          "meta" : {
+            "$ref" : "#/components/schemas/CachingMeta"
+          }
+        }
+      },
+      "DeletedMinistry" : {
+        "type" : "object",
+        "required" : [ "id", "type" ],
+        "properties" : {
+          "id" : {
+            "type" : "string",
+            "description" : "The unique ID of the Ministry.",
+            "example" : "7mUCKHxu0sve8ecXAFLJ21"
+          },
+          "type" : {
+            "type" : "string",
+            "description" : "Always the literal string 'deletedMinistry'.  This is used as a discriminator.",
+            "example" : "deletedMinistry",
+            "enum" : [ "deletedMinistry" ]
+          }
+        }
+      },
+      "Page" : {
+        "type" : "object",
+        "required" : [ "id", "type", "attributes", "links", "meta" ],
+        "properties" : {
+          "id" : {
+            "type" : "string",
+            "description" : "The unique ID of the Page.  Referenced by the Ministry Homepage.",
+            "example" : "5GFx0YjJTczOBNyFUASQAu"
+          },
+          "type" : {
+            "type" : "string",
+            "description" : "Always the literal string 'page'.  This is used as a discriminator.",
+            "example" : "page",
+            "enum" : [ "page" ]
+          },
+          "attributes" : {
+            "$ref" : "#/components/schemas/PageAttributes"
+          },
+          "links" : {
+            "type" : "object",
+            "required" : [ "canonical" ],
+            "properties" : {
+              "canonical" : {
+                "type" : "string",
+                "description" : "A link to the canonical landing page for this ministry.",
+                "example" : "https://www.watermark.org/ministries/re-generation"
+              }
+            }
+          },
+          "meta" : {
+            "$ref" : "#/components/schemas/CachingMeta"
+          }
+        }
+      },
+      "PageAttributes" : {
+        "type" : "object",
+        "required" : [ "title", "slug", "displayTitle", "description" ],
+        "properties" : {
+          "slug" : {
+            "type" : "string",
+            "example" : "/re-generation"
+          },
+          "title" : {
+            "type" : "string",
+            "example" : "Re:Generation"
+          },
+          "description" : {
+            "type" : "string",
+            "example" : "A biblically-based 12-step recovery program"
+          },
+          "displayTitle" : {
+            "type" : "boolean"
+          }
+        }
+      },
+      "PageRelationship" : {
+        "type" : "object",
+        "required" : [ "data" ],
+        "properties" : {
+          "data" : {
+            "type" : "object",
+            "required" : [ "type", "id" ],
+            "properties" : {
+              "type" : {
+                "type" : "string",
+                "enum" : [ "page" ]
+              },
+              "id" : {
+                "type" : "string",
+                "example" : "5GFx0YjJTczOBNyFUASQAu"
+              }
+            }
+          }
+        }
+      },
+      "CachingMeta" : {
+        "type" : "object",
+        "required" : [ "ETag", "Last-Modified" ],
+        "properties" : {
+          "ETag" : {
+            "type" : "string",
+            "description" : "The strong ETag is a digest of this resource.  You can use the 'If-None-Match' HTTP header to do a conditional GET to the 'self' link of this person.  Note the explicit quotation marks in the string - these must be included in the HTTP header.",
+            "example" : "\"67ca6661a69398674a62a1f2e55465d8\""
+          },
+          "Last-Modified" : {
+            "type" : "string",
+            "description" : "A timestamp when this resource was last modified.  You can use the 'If-Modified-Since' HTTP header to do a conditional GET to the 'self' link of this person.",
+            "example" : "Mon, 27 Jul 2020 19:15:30 GMT"
+          }
+        }
+      }
+    }
+  }
+}

data/wcc_ministries_client.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#WCC Ministries API
+
+#WCC Ministries API
+
+The version of the OpenAPI document: 1.0.0
+Contact: dev@watermark.org
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "wcc_ministries_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wcc_ministries_client"
+  s.version     = WCC::Ministries::Client::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Watermark Community Church"]
+  s.email       = ["dev@watermark.org"]
+  s.homepage    = "https://www.watermark.org"
+  s.summary     = "WCC Ministries API Ruby Gem"
+  s.description = "WCC Ministries API"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end