bettery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75102720ef2fe05113049f2116c176b00cd6e985
+  data.tar.gz: 958b545b5c80a17962994ab0a19898b2eabbc4df
+SHA512:
+  metadata.gz: 2b295918c558ec7645c891118894b40c13a0129142410ad941596e847bc55c8e6f136235c3b6ac0aa97dfd466feb20eabe6a13ebe314d2075ca4949af42893ec
+  data.tar.gz: db6bf57dbd99e2b318615e11ab8ad04897f286bcabb53db6e7ac631ca4132d4696f2cc318c544682dbad9dc9046a2f883e8e9f7a2a7168c1feca23153a99fa77

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--title=""
+--markup=markdown
+--template-path=./yard
+--exclude lib/bettery/response

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0.0'
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+  gem 'vcr', '~> 2.9.2'
+  gem 'webmock', '~> 1.9'
+end
+
+# Specify your gem's dependencies in bettery.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Duilio Ruggiero
+
+MIT License
+
+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,38 @@
+# Bettery
+
+[![Build Status](https://travis-ci.org/sinetris/bettery.svg?branch=master)](https://travis-ci.org/sinetris/bettery)
+[![Coverage Status](https://img.shields.io/coveralls/sinetris/bettery.svg)](https://coveralls.io/r/sinetris/bettery?branch=master)
+[![Dependency Status](https://gemnasium.com/sinetris/bettery.svg)](https://gemnasium.com/sinetris/bettery)
+
+Ruby toolkit for working with the [Betterplace API][betterplace_api].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bettery', github: 'sinetris/bettery'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+projects = Bettery.projects
+projects.fields => #<Set: {:total_entries, :offset, :total_pages, :current_page, :per_page, :data}>
+projects.total_entries #=> 11149
+projects.data.first.title #=> "Mit der DKMS im Kampf gegen Blutkrebs!"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sinetris/bettery/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[betterplace_api]: https://github.com/betterplace/betterplace_apidocs

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bettery.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bettery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bettery"
+  spec.version       = Bettery::VERSION
+  spec.authors       = ["Duilio Ruggiero"]
+  spec.email         = ["duilio.ruggiero@gmail.com"]
+  spec.summary       = %q{Betterplace API wrapper in Ruby.}
+  spec.description   = %q{Ruby toolkit for working with the Betterplace API.}
+  spec.homepage      = "https://github.com/sinetris/bettery"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+
+  spec.add_runtime_dependency 'sawyer', '~> 0.5'
+end

data/lib/bettery.rb

@@ -0,0 +1,28 @@
+require 'bettery/client'
+require 'bettery/default'
+
+# Ruby toolkit for the Betterplace API
+module Bettery
+  class << self
+    include Bettery::Configurable
+
+    # API client based on configured options {Configurable}
+    #
+    # @return [Bettery::Client] API wrapper
+    def client
+      unless defined?(@client) && @client.same_options?(options)
+        @client = Bettery::Client.new(options)
+      end
+      @client
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end
+
+Bettery.setup

data/lib/bettery/client.rb

@@ -0,0 +1,170 @@
+require 'sawyer'
+require 'bettery/configurable'
+require 'bettery/project'
+require 'bettery/client/projects'
+
+module Bettery
+
+  # Client for the Betterplace API
+  #
+  # @see https://developer.betterplace.org
+  class Client
+    include Bettery::Configurable
+    include Bettery::Client::Projects
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    # Current API version
+    API_VERSION  = "api_v4"
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Bettery::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Bettery.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    # API endpoint
+    # @return [String]
+    def api_endpoint
+      File.join(api_base_endpoint, locale, API_VERSION)
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Hypermedia agent for the Betterplace API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:user_agent] = user_agent
+      end
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    private
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+
+      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      response.data
+    end
+
+    # Executes the request, checking if it was successful
+    #
+    # @return [Boolean] True on success, false otherwise
+    def boolean_from_response(method, path, options = {})
+      request(method, path, options)
+      @last_response.status == 204
+    rescue Bettery::NotFound
+      false
+    end
+
+    def paginate(url, options = {}, &block)
+      opts = parse_query_and_convenience_headers(options.dup)
+      request(:get, url, opts)
+    end
+
+    def sawyer_options
+      opts = {
+        links_parser:Sawyer::LinkParsers::Simple.new
+      }
+      conn_opts = @connection_options
+      conn_opts[:builder] = @middleware if @middleware
+      conn_opts[:proxy] = @proxy if @proxy
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      headers = options.fetch(:headers, {})
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options.delete(h)
+          headers[h] = header
+        end
+      end
+      query = options.delete(:query)
+      opts = {query: options}
+      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:headers] = headers unless headers.empty?
+
+      opts
+    end
+  end
+end

data/lib/bettery/client/projects.rb

@@ -0,0 +1,45 @@
+module Bettery
+  class Client
+
+    # Methods for the Projects API
+    #
+    # @see https://github.com/betterplace/betterplace_apidocs
+    module Projects
+
+      # Check if a project exists
+      #
+      # @see https://github.com/betterplace/betterplace_apidocs
+      # @param project [Integer, String, Hash, Project] A Betterplace project
+      # @return true if a project exists, false otherwise
+      def project?(project, options = {})
+        !!project(project, options)
+      rescue Bettery::NotFound
+        false
+      end
+
+      # Get a single project
+      #
+      # @see https://github.com/betterplace/betterplace_apidocs
+      # @param project [Integer, String, Hash, Project] A Betterplace project
+      # @return [Sawyer::Resource] Project information
+      def project(project, options = {})
+        get Bettery::Project.path(project), options
+      end
+
+      # List all projects
+      #
+      # This provides a dump of every project, in the order that they were
+      # created.
+      #
+      # @see https://github.com/betterplace/betterplace_apidocs
+      #
+      # @param options [Hash] Optional options
+      # @option options [Integer] :since The integer ID of the last Project
+      #   that you’ve seen.
+      # @return [Sawyer::Resource] List of projects.
+      def projects(options = {})
+        get 'projects.json', options
+      end
+    end
+  end
+end

data/lib/bettery/configurable.rb

@@ -0,0 +1,41 @@
+module Bettery
+  module Configurable
+    attr_accessor :api_base_endpoint, :connection_options, :default_media_type,
+                  :locale, :middleware, :per_page, :proxy, :user_agent
+
+    class << self
+      def keys
+        @keys ||= [
+          :api_base_endpoint,
+          :connection_options,
+          :default_media_type,
+          :locale,
+          :middleware,
+          :per_page,
+          :proxy,
+          :user_agent
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      Bettery::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Bettery::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    private
+
+    def options
+      Hash[Bettery::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end