cartodb-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4935b964b5d6c1696b7d40e4523841b7bb26dd6
+  data.tar.gz: ea948d6ec927b6f216d6acc5b4221d3d2d25a462
+SHA512:
+  metadata.gz: 884bfa172f755b0f343dd7e771c416680e3fc4a0fa96bc664be69fe453fd20d48e6dfd3cfa755103975f576863fb252a75a7f8501e91b486fb326aff1ea0d6ef
+  data.tar.gz: 6cf5f9a1ff09b8744aeae30a09e32d8a374cd47f0480ce00f7cf9ed87f49d206e368674971473ec04c3b1c3c487bf604e4dc21413731263a4e8ab9d0c6c27dab

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# How to contribute
+
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. You should follow the git branching model and pull request template detailed in the _Additional_ _Resources_ section.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the develop branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on develop; `git checkout -b
+    my-contribution develop`. Please avoid working directly on the
+    `develop` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+* Include in the title between parenthesis the issue it fixes if one exists.
+
+````
+    (Fixes #97) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example. This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Making Trivial Changes
+
+### Documentation
+
+For changes of a trivial nature to comments and documentation, it is not
+always necessary to create a new ticket. In this case, it is
+appropriate to start the first line of a commit with '(doc)' instead of
+a ticket number.
+
+````
+    (doc) Add documentation commit example to CONTRIBUTING
+
+    There is no example for contributing a documentation commit
+    to the repository. This is a problem because the contributor
+    is left to assume how a commit of this nature may appear.
+
+    The first line is a real life imperative statement with '(doc)' in
+    place of what would have been the ticket number in a
+    non-documentation related commit. The body describes the nature of
+    the new documentation or comments added.
+````
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository in the Github respository.
+* Update your ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
+  * Include a link to the pull request in the ticket.
+* After feedback has been given you can expect responses within two weeks. After two
+  weeks we may close the pull request if it isn't showing any activity.
+
+# Additional Resources
+
+* [Git branching model](http://nvie.com/posts/a-successful-git-branching-model/)
+* [Pull request template](https://quickleft.com/blog/pull-request-templates-make-code-review-easier/)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cartodb-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pablo Cárdenas
+
+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,45 @@
+[![Code Climate](https://codeclimate.com/github/pablo-co/cartodb-api/badges/gpa.svg)](https://codeclimate.com/github/pablo-co/cartodb-api)
+
+[![Test Coverage](https://codeclimate.com/github/pablo-co/cartodb-api/badges/coverage.svg)](https://codeclimate.com/github/pablo-co/cartodb-api/coverage)
+
+# CartoDB::Api
+
+CartoDB::Api is an API library for Ruby which acts as a wrapper for [CartoDB's API](cartodb.com). All requests are built using a really simple fluid interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cartodb-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cartodb-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pablo-co/cartodb-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+There are also a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. These are detailed in the [Contributing guidelines](contributor-covenant.org).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cartodb/api'
+
+require 'irb'
+IRB.start

data/bin/setup

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

data/cartodb-api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cartodb/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cartodb-api'
+  spec.version       = CartoDB::Api::VERSION
+  spec.authors       = ['Pablo Cárdenas']
+  spec.email         = ['pcardenasoliveros@gmail.com']
+
+  spec.summary       = %q{A wrapper for CartoDB's API}
+  spec.description   = %q{CartoDB::Api is an API wrapper for CartoDB written in Ruby}
+  spec.homepage      = 'https://github.com/pablo-co/cartodb-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+
+  spec.add_dependency('faraday', '>= 0.9.1')
+  spec.add_dependency('multi_json', '>= 1.11.2')
+end

data/lib/cartodb/api.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+require 'multi_json'
+
+require 'cartodb/api/version'
+require 'cartodb/api/request'
+require 'cartodb/api/configuration'
+require 'cartodb/api/error'
+
+module CartoDB
+  module Api
+    class << self
+      # Public: Initializes a new CartoDB::Api::Request.
+      #
+      # configuration - The optional CartoDB::Api::Configuration used to configure
+      #                 this CartoDB::Api::Request.
+      #
+      # Examples
+      #
+      #   CartoDB::Api.new 'http://faraday.com'
+      #
+      #
+      # Returns a CartoDB::Api::Request.
+      def new(configuration)
+        build_request(configuration)
+      end
+
+      def method_missing(sym, *args, &block)
+        build_request.send(sym, *args, &block)
+      end
+
+      def default_configuration=(configuration)
+        @@default_configuration = configuration
+      end
+
+      protected
+
+      def build_request(configuration = nil)
+        configuration = configuration ? default_configuration.merge(configuration) : default_configuration.dup
+        CartoDB::Api::Request.new(configuration)
+      end
+
+      private
+
+      def default_configuration
+        @@default_configuration ||= CartoDB::Api::Configuration.new
+      end
+
+    end
+  end
+end

data/lib/cartodb/api/configuration.rb

@@ -0,0 +1,69 @@
+module CartoDB
+  module Api
+    class Configuration
+
+      PROTOCOL = 'https'
+      DOMAIN = 'cartodb.com'
+      TIMEOUT = 30
+      VERSION = 1
+
+      # Public: Gets or sets the CartoDB account from which all requests are going to be made from.
+      attr_accessor :account
+
+      # Public: Gets or sets the CartoDB API key that will be used for authentication.
+      attr_accessor :api_key
+
+      # Public: Sets the protocol that will be used for requests
+      attr_writer :protocol
+
+      # Public: Sets the domain name for all HTTP requests
+      attr_writer :domain
+
+      # Public: Sets the request timeout
+      attr_writer :timeout
+
+      # Public: Sets the CartoDB API version
+      attr_writer :version
+
+      def protocol
+        @protocol || PROTOCOL
+      end
+
+      def domain
+        @domain || DOMAIN
+      end
+
+      def version
+        @version || VERSION
+      end
+
+      def timeout
+        @timeout || TIMEOUT
+      end
+
+      def base_url
+        assert_configuration
+        "#{protocol}://#{account}.#{domain}/api/"
+      end
+
+      def assert_configuration
+        assert_attr(account, 'Account')
+        assert_attr(api_key, 'API key')
+        assert_in_options(protocol, %w{http https}, 'Protocol')
+        assert_attr(domain, 'Domain')
+        assert_attr(version, 'API version number')
+      end
+
+      def assert_attr(attr, attr_name)
+        raise InvalidConfiguration.new("#{attr_name} should not be nil.") if attr.nil?
+      end
+
+      def assert_in_options(attr, options, attr_name)
+        assert_attr(attr, attr_name)
+        exception_message = "#{attr_name} is not a valid option. Should be any of: #{options.join(', ')}"
+        raise InvalidConfiguration.new(exception_message) unless options.include? attr
+      end
+
+    end
+  end
+end

data/lib/cartodb/api/error.rb

@@ -0,0 +1,16 @@
+module CartoDB
+  module Api
+    class ConnectionFailed < StandardError
+    end
+
+    class InvalidConfiguration < StandardError
+    end
+
+    class Error < StandardError
+      attr_accessor :title, :details, :body, :raw_body, :status_code
+    end
+
+    class ParsingError < Error
+    end
+  end
+end

data/lib/cartodb/api/request.rb

@@ -0,0 +1,136 @@
+module CartoDB
+  module Api
+    class Request
+      extend Forwardable
+
+      attr_accessor :configuration
+
+      def_delegators :configuration, :protocol, :domain, :api_key,
+                     :account, :base_url, :version, :timeout
+
+      def initialize(configuration)
+        self.configuration = configuration
+        reset
+      end
+
+      def method_missing(method, *args)
+        @path_steps << method.downcase
+        @path_steps << args if args.length > 0
+        @path_steps.flatten!
+        self
+      end
+
+      def create(params = nil, headers = nil, body = nil)
+        make_request(:post, params, headers, body)
+      end
+
+      def update(params = nil, headers = nil, body = nil)
+        make_request(:patch, params, headers, body)
+      end
+
+      def retrieve(params = nil, headers = nil)
+        make_request(:get, params, headers)
+      end
+
+      def delete(params = nil, headers = nil)
+        make_request(:delete, params, headers)
+      end
+
+      protected
+
+      def reset
+        @path_steps = []
+      end
+
+      def client
+        Faraday.new(url: url) do |client|
+          client.params['api_key'] = api_key
+          client.response :raise_error
+          client.adapter Faraday.default_adapter
+        end
+      end
+
+      def make_request(method, params = nil, headers = nil, body = nil)
+        begin
+          response = client.send(method) do |request|
+            configure_request(request, params, headers, body)
+          end
+        rescue => e
+          rescue_error(e)
+        end
+        parse(response.body)
+      end
+
+      def configure_request(request, params = nil, headers = nil, body = nil)
+        request.params.merge!(params) if params
+        request.headers['Content-Type'] = 'application/json'
+        request.headers.merge!(headers) if headers
+        request.body = body if body
+        request.options.timeout = timeout
+      end
+
+      def parse(response)
+        return nil if response.nil?
+
+        begin
+          MultiJson.load(response).to_h
+        rescue MultiJson::ParseError
+          exception_message = "Couldn't parse response body: #{response}"
+          exception = ParsingError.new(exception_message)
+          build_error(exception,
+                      'Error parsing the response as body.',
+                      'The response given by the server is not in JSON format.',
+                      response,
+                      response)
+          exception.status_code = -1
+          raise exception
+        end
+      end
+
+      def url
+        "#{configuration.base_url}#{version_path}#{path}"
+      end
+
+      def version_path
+        "v#{version}/"
+      end
+
+      def path
+        @path_steps.join('/')
+      end
+
+      def rescue_error(exception)
+        cartodb_exception = Error.new(exception.message)
+
+        is_faraday_exception = exception.is_a?(Faraday::Error::ClientError)
+        if is_faraday_exception && exception.response
+          cartodb_exception = build_error_from_faraday(cartodb_exception,
+                                                       exception)
+        end
+
+        raise cartodb_exception
+      end
+
+      def build_error_from_faraday(cartodb_exception, exception)
+        cartodb_exception.status_code = exception.response[:status]
+        begin
+          response = MultiJson.load(exception.response[:body])
+          build_error(cartodb_exception,
+                      response['title'],
+                      response['detail'],
+                      response,
+                      exception.response[:body]) if response
+        rescue MultiJson::ParseError => _
+        end
+        cartodb_exception
+      end
+
+      def build_error(exception, title, details, body, raw_body = nil)
+        exception.title = title if title
+        exception.details = details if details
+        exception.body = body
+        exception.raw_body = raw_body if raw_body
+      end
+    end
+  end
+end

data/lib/cartodb/api/version.rb

@@ -0,0 +1,5 @@
+module CartoDB
+  module Api
+    VERSION = '0.0.2'
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: cartodb-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pablo Cárdenas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: CartoDB::Api is an API wrapper for CartoDB written in Ruby
+email:
+- pcardenasoliveros@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cartodb-api.gemspec
+- lib/cartodb/api.rb
+- lib/cartodb/api/configuration.rb
+- lib/cartodb/api/error.rb
+- lib/cartodb/api/request.rb
+- lib/cartodb/api/version.rb
+homepage: https://github.com/pablo-co/cartodb-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A wrapper for CartoDB's API
+test_files: []