Giter VIP home page Giter VIP logo

athenaeum-redmine's Introduction

Athenaeum Redmine (API Client)

A Laravel Redmine API Client, that has been designed to look and feel like an active record.

Example:

use Aedart\Redmine\Issue;
use Aedart\Redmine\Project;
use Aedart\Redmine\IssueCategory;
use Aedart\Contracts\Http\Clients\Requests\Builder;

// Create resources
$project = Project::create([
    'name' => 'Deus Ex',
    'identifier' => 'deus-ex'
]);

// Fetch list of resources, apply filters to http request...
$issues = Issue::fetchMultiple(function(Builder $request) {
    return $request->where('assigned_to_id', 'me');
});

// Change existing resources
$category = IssueCategory::findOrFail(1344);
$category->update([
    'name' => 'Business Goals'
]);

// ...or remove them
Issue::findOrFail(9874)
    ->delete();

Compatibility

Athenaeum Redmine Client Redmine version
From v5.19 >= v4.x*

*:This package might also work with newer versions of Redmine.

Limitations

This package offers "Resources" that cover most of Redmine's REST Api. Yet, if you have previously worked with Redmine's API, then you know that it can be somewhat inconsistent. Depending on the resource that you are working with, you might not be able to perform certain operations, because it's not supported by the API. You might therefore experience the following exception:

\Aedart\Contracts\Redmine\Exceptions\UnsupportedOperationException

Please consult yourself with Redmine's Api documentation, to review what operations the current API version supports.

Alternative

You might also be interested in alternative Redmine API Clients:

Documentation

Please read the official documentation for additional information.

Repository

The mono repository is located at github.com/aedart/athenaeum

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package

athenaeum-redmine's People

Contributors

aedart avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.