strawberry_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a9d87bca38fb60a6a072aed8655ed0122247fdff9171287466d82de25170554
+  data.tar.gz: cecf2b9d22250f1c301b3e8b92bf8f7a5ca7c1eec4953b5adbc0492639a18d98
+SHA512:
+  metadata.gz: 561cf427bb439ac2ea77cd100512b1dbdee6a687b9c3b5edbc30cb13d50d2fd518589592a8a9420b3e12dad9903e4e36bb57637625d317b6a3a0663158b96b4c
+  data.tar.gz: 6e5ab60cdefb33b32d4d7d5ba699b4ba118cc7b9f55983f6acafa7b3d0ba4b5bbfb07e6667ca4ca48ffbbed7e38cfa88f762ff36a8c7bf9c6a82a7d22e2cc69c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*.gem

data/.rubocop.yml

@@ -0,0 +1,4 @@
+{
+  AllCops:
+  TargetRubyVersion: 2.5
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pierreyves.lebrun@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem 'httparty'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pierre Lebrun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# Strawberry
+
+A simple Ruby gem acting as a client for [Flavoursys Strawberry](http://www.flavoursys.com) REST API.
+
+This unofficial implementation covers most of the features offered by Strawberry API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strawberry_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strawberry_api
+
+## Usage
+
+### Authentication
+
+Authenticate to the server via regular credentials or by using an API key. A standard error will be raised if authentication fails.
+
+#### API key based authentication
+
+```ruby
+require 'strawberry_api'
+
+StrawberryAPI.configure do |c|
+  c.host = 'server_IP_or_hostname'
+  c.api_key = 'api_key'
+end
+
+strawberry = StrawberryAPI::Client.new
+
+# Returns currently logged in user info
+strawberry.user
+# => "#<Strawberry::API::User: id=2, username="api", ...
+```    
+#### User credentials based authentication
+```ruby
+require 'strawberry_api'
+
+StrawberryAPI.configure do |c|
+  c.host = 'server_IP_or_hostname'
+  c.username = 'username'
+  c.password = 'password'
+end
+
+strawberry = StrawberryAPI::Client.new
+
+# Returns currently logged in user info
+strawberry.user
+# => "#<Strawberry::API::User: id=2, username="api", ...
+```
+
+
+### Making requests
+
+#### Strawberry API client
+
+[API methods](doc/Strawberry/Client.html) are available as client instance methods.
+
+```ruby
+strawberry = Strawberry::Client.new
+
+# Returns all Strawberry projects
+strawberry.projects
+# => [#<Strawberry::API::Project: id=6, name="test_project", ...
+```
+
+### Samples
+
+Most API methods return an object which provide dot notation access for fields returned in the API response.
+
+See the [samples](samples) directory for more examples.
+
+#### Methods returning an object
+
+```ruby
+strawberry.project(id: 6)
+# => #<Strawberry::API::Project: id=6, name="test_project", ...
+```
+
+#### Methods returning an array of project objects
+
+Some methods return an array of objects .
+
+```ruby
+strawberry.projects
+# => [#<Strawberry::API::Project: id=6, name="test_project", ...
+
+```
+
+#### Methods returning a Boolean
+
+A few other methods return a Boolean.
+The following example uses the `video?` method which indicates whether the asset is a video or not.
+
+```ruby
+assets = strawberry.assets
+# => [#<Strawberry::API::Asset: id=6, name="test_asset", ...
+
+assets.each do |asset|
+  # Returns true of false
+  if asset.video?
+    puts "Asset #{asset.name} is a video"
+  else
+    puts "Asset #{asset.name} is not a video"
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/strawberry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Strawberry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/strawberry/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "strawberry"
+
+# 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/doc/HTTParty/Response.html

@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: HTTParty::Response
+  
+    &mdash; Documentation by YARD 0.9.16
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "HTTParty::Response";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../StrawberryAPI.html" title="StrawberryAPI (module)">StrawberryAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../StrawberryAPI/HttpClient.html" title="StrawberryAPI::HttpClient (class)">HttpClient</a></span></span> &raquo; <span class='title'>HTTParty</span>
+     &raquo; 
+    <span class="title">Response</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: HTTParty::Response
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">HTTParty::Response</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/strawberry_api/http_client.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Class HTTParty::Response provides methods to handle HTTP reponses</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Author:</p>
+<ul class="author">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'>
+<p>John Nunemaker &lt;nunemaker@gmail.com&gt;</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Aug 30 12:51:42 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.0).
+</div>
+
+    </div>
+  </body>
+</html>