almapi 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92f368edda78eb8a33c2941d44e7c2e737b309e625c3fa4b56a76a09908356b4
-  data.tar.gz: e25f8932a1d6a39ded7d8b93f4fc0a1324d70b399607777cef0374e2fcfe9c00
+  metadata.gz: 0f2c26aa18fade1372b97275580085b9ad05a60a2f7e73dca141e65f6990045d
+  data.tar.gz: b2e04d2a9f615f33db3c1802dd49894ddaa83397c629b73002080b6642478b48
 SHA512:
-  metadata.gz: cfb6cd7d7473be8574058a4f2e1409c5cb7a28eafcd4773e14c9ed7d2032497c4699bef03b7a86f903ca8a60c069974068a129325894570eeafa77104dd6f77c
-  data.tar.gz: 5101af4dc5f61e6e03c53bfd560f6d9fd1feb68d980b446a6bc96f857d4d2847ce326ad5b0d5510c0a3e1c97828f5e7a8215619a7fb8478f1dfe12e895b1681e
+  metadata.gz: 285d020a9b515fb8f28c77cc61e921460d60b4ab33d7c19bcdd0a6efb959f57ffbd233276ee6dff4399263e26dffb77a82bcedd2a56849770f2102e649b6ad89
+  data.tar.gz: e7cdb29ad8984185b9c2b846f88afb09196c336f68ed7d35fab7b60f905a1245ab2308d17a1c4875ecd953bc26f808d278f41bd60732e7e9d9838d7d8b889d76

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+## [0.1.5] - 2024-04-04
+
+- Still trying to require_relative error (learning to create gem so may take a few versions :) .
+
+## [0.1.1] to [0.1.4]- 2024-04-04
+
+- Correct require_relative error.
+
+## [0.1.0] - 2024-03-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jerome.chiavassa-szenberg@campus-condorcet.fr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,60 @@
+# Almapi
+
+This gem is used to handle Alma'a API call.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add almapi
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install almapi
+
+## Usage
+
+Almapi provides an Alampi module which contains the Api class. 
+
+An Api class object is created with two mandatory information: an key for Alma's API and a base URI for Alma's API.
+
+The Api class is providing the following methods:
+* delete: to handle DELETE method calls. Needs two mandatory parameters: resource and data
+* get: to handle GET method calls. Needs two mandatory parameters: resource and resumption_token
+* post: to handle PSOT method calls. Needs two mandatory parameters: resource and data
+* put: to handle PUT method calls. Needs two mandatory parameters: resource and data
+
+Here is a description of each parameter mentionned above:
+* resource: it is the part that completes the base uri to create a complete Alma's API call, with the various ids and necessary parameters but without the apikey parameter that will be added automatically. 
+* data: the XML data needed by the called resource and method.
+* resumption_token: is parameter is not mandatory and is used only for analytics calls.
+
+## Documentation
+
+Documentation is provided in `doc` folder (use `yard`).
+
+## Development
+
+Put your Ruby code in the file `lib/almapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests (see below). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Testing
+
+Tested using `rspec`. 
+
+In spec directory, define a `almapi_spec_init.rb` with two string constants : APIKEY and URIBASE, giving an api key value and a uri base value.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jszenb/almapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jszenb/almapi/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Almapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jszenb/almapi/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "almapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/almapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Almapi
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/almapi.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "./almapi/version"
-require_relative './almapi/almapi_error'
-require_relative './almapi/almapi'
+require "almapi/version"
+require "almapi/almapi_error"
+require "almapi/almapi"
 
 # Module Almapi handles Alma's API call and errors
 # @author jszenb

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: almapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - jszenb
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
@@ -115,6 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/console
+- bin/setup
 - lib/almapi.rb
 - lib/almapi/almapi.rb
 - lib/almapi/almapi_error.rb