liblynx-api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1721e67204106823f15655d3e4ac2a35ae71c23f0b716d3ff54bb321c1313e09
-  data.tar.gz: 53947628a0695b4430227af5883cbb7aea44497a96d89fd2bdb763292de3deca
+  metadata.gz: ba21c208b05e9e4924e74c00ba2e6b82885d1d260092bc9a6a5410ef48726c51
+  data.tar.gz: fe1ee8f9e390861a23b575144153515edbf39d6ee878ec8eb98c4c8fd5c1d207
 SHA512:
-  metadata.gz: 067ec4853a37ff4ee77aae4297f6a5f64605c9da7087cba6556f7792514eb6a984f18b003d1b7527ecb2a20b05753cd89de467eefe0ea3588a2d1d0933947366
-  data.tar.gz: b7b0eb7b424d4edc954a1a1c5f61ff141d1e827e01617c17e85d9c2e773ee2282bd0e265ab37da75294d5f8090a1212cf751d6e13b1990832a17c6da5593bb3f
+  metadata.gz: 10f20997e5868b79fad06852ec21083b70169cce1f25b1c9f5c4857bcb4debf739d739c94b7f71c19e62ba4cb6ee5c7c495c70b3d29fe29d01aa9410ad5c069d
+  data.tar.gz: 4f0f4cab62b3a82b6c99e256ec517ba8b064e7ecbd02d333898111a3c7c6984d87f9a88743700182a39913fa34116d9fceed780552f278dfd6fcd241e86576c5

data/.travis.yml

@@ -4,4 +4,5 @@ deploy:
     secure: OxGYvmusVgh8GzIkRMTUXmTF/xNUs6W5pbVivRzCv1zlPmlFncbmd52WAytq7A5SioI07SYaaeF3Y9/AaEhh0vBteFcmWg32mMGt6FIAaOGyTi8s42mfp9RFZqcPZKb+DM/qr9pFPgUgFogJC7SIEEGhp07SOyrvK928A19H3XLOQbXTm11Pmf1+wBCuxOs84I74UflZw+qCRDfxGWheycna0fIEfev5tGeW/thotYKi2z5l4qNmqysnlW6zO380ORvschrWu+vSgTKELjo9d6AhK3dRBCC1c5VgVs0PaoLEpKRDtbBUuD8UmbKGTI/wgjEnwcj3S3FUoUGIBBis1WCX9TpQ7iSrWDAg1vQ3iKedWRJ65blt10kgwH5nRfk9JdmENviAGDNYwIGkKfMGRDZnq07gWUBSHx2kIKcvrFyovoHGJ8Zfk5b65YMB0JQw6sVx9kV4flstrJ4kgVMPOIy6U+RbSroSvJ2iOHsXxH1zTk4YtZrmow57jlQV4iUKOxkUIBdFKYCT9ucVOhfzfDoay4q4qY1Q/Ohf5GSJphNa7uwhjwnOkjiwvFTyfUiU6FD8NjIwlJ84dy3DrOmJBfj1Tj5/Z/hgH/lp/309T1rsY0fv5ebbktRg+L82mh0LK/bsFcVwskrOI7+WX6a4gmqBEZ4kdTNrYvU2R+VRuTY=
   gem: liblynx-api
   on:
+    tags: true
     repo: dsablic/liblynx-api

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    liblynx-api (1.0.1)
+    liblynx-api (1.1.0)
       heroics
       moneta
 
@@ -10,7 +10,7 @@ GEM
   specs:
     diff-lcs (1.3)
     erubis (2.7.0)
-    excon (0.60.0)
+    excon (0.62.0)
     heroics (0.0.24)
       erubis (~> 2.0)
       excon

data/api.md

@@ -217,11 +217,21 @@ List existing accounts.
 GET /api/accounts
 ```
 
+#### Optional Parameters
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **page** | *integer* | page number | `42` |
+| **perpage** | *integer* | page size | `42` |
+
 
 #### Curl Example
 
 ```bash
 $ curl -n https://connect.liblynx.com/api/accounts
+ -G \
+  -d perpage=42 \
+  -d page=42
 ```
 
 
@@ -509,6 +519,69 @@ HTTP/1.1 200 OK
 ```
 
 
+## <a name="resource-idp">idp</a>
+
+Stability: `production`
+
+
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **entity_id** | *string* | shibboleth entity id | `"example"` |
+| **logo_small_size** | *string* | logo size (WxH) | `"example"` |
+| **logo_small_url** | *string* | logo url | `"example"` |
+| **name** | *string* | name of the institution | `"example"` |
+
+### <a name="link-GET-idp-/api/idps">idp List</a>
+
+List shibboleth idps.
+
+```
+GET /api/idps
+```
+
+#### Optional Parameters
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **page** | *integer* | page number | `42` |
+| **perpage** | *integer* | page size | `42` |
+| **q** | *string* | query string | `"example"` |
+
+
+#### Curl Example
+
+```bash
+$ curl -n https://connect.liblynx.com/api/idps
+ -G \
+  -d q=example \
+  -d perpage=42 \
+  -d page=42
+```
+
+
+#### Response Example
+
+```
+HTTP/1.1 200 OK
+```
+
+```json
+{
+  "idps": [
+    {
+      "name": "example",
+      "entity_id": "example",
+      "logo_small_url": "example",
+      "logo_small_size": "example"
+    }
+  ]
+}
+```
+
+
 ## <a name="resource-samlidp">Samlidp</a>
 
 Stability: `production`

data/lib/liblynx-api/client.rb

@@ -83,7 +83,7 @@ module LibLynxAPI
 
   # Get the default options.
   def self.default_options
-    default_headers = {"Accept"=>"application/json", "User-Agent"=>"liblynx-api/1.0.0"}
+    default_headers = {"Accept"=>"application/json", "User-Agent"=>"liblynx-api/1.1.0"}
     {
       default_headers: default_headers,
       url:             "https://connect.liblynx.com"
@@ -112,6 +112,13 @@ module LibLynxAPI
       @identification_resource ||= Identification.new(@client)
     end
 
+    # 
+    #
+    # @return [Idp]
+    def idp
+      @idp_resource ||= Idp.new(@client)
+    end
+
     # 
     #
     # @return [Samlidp]
@@ -157,8 +164,10 @@ module LibLynxAPI
     end
 
     # List existing accounts.
-    def list()
-      @client.account.list()
+    #
+    # @param body: the object to pass as the request payload
+    def list(body = {})
+      @client.account.list(body)
     end
 
     # Update an existing account.
@@ -191,6 +200,20 @@ module LibLynxAPI
     end
   end
 
+  # 
+  class Idp
+    def initialize(client)
+      @client = client
+    end
+
+    # List shibboleth idps.
+    #
+    # @param body: the object to pass as the request payload
+    def list(body = {})
+      @client.idp.list(body)
+    end
+  end
+
   # 
   class Samlidp
     def initialize(client)
@@ -499,6 +522,25 @@ module LibLynxAPI
           "href": "/api/accounts",
           "method": "GET",
           "rel": "instances",
+          "schema": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "perpage": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page size"
+              },
+              "page": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page number"
+              }
+            }
+          },
           "targetSchema": {
             "properties": {
               "accounts": {
@@ -929,6 +971,122 @@ module LibLynxAPI
         }
       }
     },
+    "idp": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "idp",
+      "description": "",
+      "stability": "production",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "name": {
+          "description": "name of the institution",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "entity_id": {
+          "description": "shibboleth entity id",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "logo_small_url": {
+          "description": "logo url",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "logo_small_size": {
+          "description": "logo size (WxH)",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "$ref": "#/definitions/idp/definitions/entity_id"
+        }
+      },
+      "links": [
+        {
+          "description": "List shibboleth idps.",
+          "href": "/api/idps",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List",
+          "schema": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "q": {
+                "type": [
+                  "string"
+                ],
+                "description": "query string"
+              },
+              "perpage": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page size"
+              },
+              "page": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page number"
+              }
+            }
+          },
+          "targetSchema": {
+            "properties": {
+              "idps": {
+                "items": {
+                  "properties": {
+                    "name": {
+                      "$ref": "#/definitions/idp/definitions/name"
+                    },
+                    "entity_id": {
+                      "$ref": "#/definitions/idp/definitions/entity_id"
+                    },
+                    "logo_small_url": {
+                      "$ref": "#/definitions/idp/definitions/logo_small_url"
+                    },
+                    "logo_small_size": {
+                      "$ref": "#/definitions/idp/definitions/logo_small_size"
+                    }
+                  }
+                },
+                "type": [
+                  "array"
+                ]
+              }
+            }
+          }
+        }
+      ],
+      "properties": {
+        "name": {
+          "$ref": "#/definitions/idp/definitions/name"
+        },
+        "entity_id": {
+          "$ref": "#/definitions/idp/definitions/entity_id"
+        },
+        "logo_small_url": {
+          "$ref": "#/definitions/idp/definitions/logo_small_url"
+        },
+        "logo_small_size": {
+          "$ref": "#/definitions/idp/definitions/logo_small_size"
+        }
+      }
+    },
     "samlidp": {
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "title": "Samlidp",
@@ -1144,6 +1302,9 @@ module LibLynxAPI
     "identification": {
       "$ref": "#/definitions/identification"
     },
+    "idp": {
+      "$ref": "#/definitions/idp"
+    },
     "samlidp": {
       "$ref": "#/definitions/samlidp"
     },

data/lib/liblynx-api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LibLynxAPI
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/schema.json

@@ -253,6 +253,25 @@
           "href": "/api/accounts",
           "method": "GET",
           "rel": "instances",
+          "schema": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "perpage": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page size"
+              },
+              "page": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page number"
+              }
+            }
+          },
           "targetSchema": {
             "properties": {
               "accounts": {
@@ -683,6 +702,122 @@
         }
       }
     },
+    "idp": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "idp",
+      "description": "",
+      "stability": "production",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "name": {
+          "description": "name of the institution",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "entity_id": {
+          "description": "shibboleth entity id",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "logo_small_url": {
+          "description": "logo url",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "logo_small_size": {
+          "description": "logo size (WxH)",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "$ref": "#/definitions/idp/definitions/entity_id"
+        }
+      },
+      "links": [
+        {
+          "description": "List shibboleth idps.",
+          "href": "/api/idps",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List",
+          "schema": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "q": {
+                "type": [
+                  "string"
+                ],
+                "description": "query string"
+              },
+              "perpage": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page size"
+              },
+              "page": {
+                "type": [
+                  "integer"
+                ],
+                "description": "page number"
+              }
+            }
+          },
+          "targetSchema": {
+            "properties": {
+              "idps": {
+                "items": {
+                  "properties": {
+                    "name": {
+                      "$ref": "#/definitions/idp/definitions/name"
+                    },
+                    "entity_id": {
+                      "$ref": "#/definitions/idp/definitions/entity_id"
+                    },
+                    "logo_small_url": {
+                      "$ref": "#/definitions/idp/definitions/logo_small_url"
+                    },
+                    "logo_small_size": {
+                      "$ref": "#/definitions/idp/definitions/logo_small_size"
+                    }
+                  }
+                },
+                "type": [
+                  "array"
+                ]
+              }
+            }
+          }
+        }
+      ],
+      "properties": {
+        "name": {
+          "$ref": "#/definitions/idp/definitions/name"
+        },
+        "entity_id": {
+          "$ref": "#/definitions/idp/definitions/entity_id"
+        },
+        "logo_small_url": {
+          "$ref": "#/definitions/idp/definitions/logo_small_url"
+        },
+        "logo_small_size": {
+          "$ref": "#/definitions/idp/definitions/logo_small_size"
+        }
+      }
+    },
     "samlidp": {
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "title": "Samlidp",
@@ -898,6 +1033,9 @@
     "identification": {
       "$ref": "#/definitions/identification"
     },
+    "idp": {
+      "$ref": "#/definitions/idp"
+    },
     "samlidp": {
       "$ref": "#/definitions/samlidp"
     },

data/schemata/account.json

@@ -246,6 +246,19 @@
       "href": "/api/accounts",
       "method": "GET",
       "rel": "instances",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "perpage": {
+            "type": "integer",
+            "description": "page size"
+          },
+          "page": {
+            "type": "integer",
+            "description": "page number"
+          }
+        }
+      },
       "targetSchema": {
         "properties": {
           "accounts": {

data/schemata/idps.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "http://json-schema.org/draft-04/hyper-schema",
+  "title": "idp",
+  "description": "",
+  "stability": "production",
+  "strictProperties": true,
+  "type": [
+    "object"
+  ],
+  "definitions": {
+    "name": {
+      "description": "name of the institution",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "entity_id": {
+      "description": "shibboleth entity id",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "logo_small_url": {
+      "description": "logo url",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "logo_small_size": {
+      "description": "logo size (WxH)",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "identity": {
+      "$ref": "/schemata/idp#/definitions/entity_id"
+    }
+  },
+  "links": [
+    {
+      "description": "List shibboleth idps.",
+      "href": "/api/idps",
+      "method": "GET",
+      "rel": "instances",
+      "title": "List",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "q": {
+            "type": "string",
+            "description": "query string"
+          },
+          "perpage": {
+            "type": "integer",
+            "description": "page size"
+          },
+          "page": {
+            "type": "integer",
+            "description": "page number"
+          }
+        }
+      },
+      "targetSchema": {
+        "properties": {
+          "idps": {
+            "items": {
+              "properties": {
+                "name": {
+                  "$ref": "/schemata/idp#/definitions/name"
+                },
+                "entity_id": {
+                  "$ref": "/schemata/idp#/definitions/entity_id"
+                },
+                "logo_small_url": {
+                  "$ref": "/schemata/idp#/definitions/logo_small_url"
+                },
+                "logo_small_size": {
+                  "$ref": "/schemata/idp#/definitions/logo_small_size"
+                }
+              }
+            },
+            "type": [
+              "array"
+            ]
+          }
+        }
+      }
+    }
+  ],
+  "properties": {
+    "name": {
+      "$ref": "/schemata/idp#/definitions/name"
+    },
+    "entity_id": {
+      "$ref": "/schemata/idp#/definitions/entity_id"
+    },
+    "logo_small_url": {
+      "$ref": "/schemata/idp#/definitions/logo_small_url"
+    },
+    "logo_small_size": {
+      "$ref": "/schemata/idp#/definitions/logo_small_size"
+    }
+  },
+  "id": "schemata/idp"
+}

data/spec/client_spec.rb

@@ -23,7 +23,16 @@ describe 'The generated liblynx api client' do
     }
   end
 
-  it 'can get list the accounts' do
+  it 'can list the idps' do
+    expect(@client.idp.list).to match(hash_including('idps'))
+  end
+
+  it 'can list the idps using the query filter' do
+    expect(@client.idp.list(q: 'of denver')['idps'])
+      .to include(include('name' => 'University of Denver'))
+  end
+
+  it 'can list the accounts' do
     expect(@client.account.list).to match(hash_including('accounts'))
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liblynx-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Denis Sablic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - schema.json
 - schemata/account.json
 - schemata/identification.json
+- schemata/idps.json
 - schemata/samlidps.json
 - schemata/token.json
 - spec/client_spec.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby client for the LibLynx API