cartowrap 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aec8b6861e9df5308c3a92d3837eb2a2f1327726
-  data.tar.gz: c1393f7b197d66c13f0ea7d6082368032f1f1491
+  metadata.gz: a7a1d35830b95c2bff443958669b6fa4a5954a0b
+  data.tar.gz: 4725acd39fcc184460cc49176f2f99c0db271fd3
 SHA512:
-  metadata.gz: cae94667afb8b4893d9bfc2f0cad8e8acb56c40121c3e7eaaa1b429f816d9acbecf3a8493ec4acad6011f58f11a4b14721215adbd2ed6d304831af4be3b61912
-  data.tar.gz: a414751fa85250d00a249f93ee724447a2e34e4df521489dd552762443088daf79ddcf81122a77098b86460653de1e7cc46a0499e8e3fd189af0581802afa925
+  metadata.gz: 7aa60cc0ed1b3f3bf4bd8ac8e9d26b0442341c16e92ba90dd82d25af9c72354bd4ed62bd01425683efed6942a6eaf9befaa7e95ac58b4aeba72b63a1efab1c84
+  data.tar.gz: fe08cc252591656441c6351a9a45525ede23c3bff3295da63a6ee91b2a9a06c00d0be6e7ec1d753edf33fa58df557b3d5083510ae0abcc5c4bf743ef94c78abb

data/README.md

@@ -1,8 +1,10 @@
 # Cartowrap
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+[![Build Status](https://travis-ci.org/Vizzuality/cartowrap.svg?branch=master)](https://travis-ci.org/Vizzuality/cartowrap)
+[![Code Climate](https://codeclimate.com/github/Vizzuality/cartowrap/badges/gpa.svg)](https://codeclimate.com/github/Vizzuality/cartowrap)
+[![Test Coverage](https://codeclimate.com/github/Vizzuality/cartowrap/badges/coverage.svg)](https://codeclimate.com/github/Vizzuality/cartowrap/coverage)
+
+This gem provides a simple wrapper for Cartodb SQL and Sync API. More features coming soon.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -13,7 +15,7 @@ gem 'cartowrap'
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
@@ -21,8 +23,56 @@ Or install it yourself as:
 $ gem install cartowrap
 ```
 
+## Usage
+
+```ruby
+require 'cartowrap'
+api = Cartowrap::API.new(your_api_key, your_account)
+api.send_query('select * from country_isos')
+country_ison = JSON.parse(api.response)
+```
+
+### Usage with Rails
+
+See also [Cartomodel](https://github.com/Vizzuality/cartomodel) for Activerecord integration
+
+You can configure Cartowrap in an initializer
+```ruby
+#config/initializers/cartowrap.rb
+require 'cartowrap'
+Cartowrap.configure do |config|
+  config.account = your_cartodb_account
+  config.api_key = your_api_key
+end
+
+# Any other place in your code 
+api_call = Cartowrap::API.new
+```
+
+## Current methods
+
+```ruby
+send_query(query)
+get_synchronizations
+get_synchronization(import_id)
+check_synchronization(import_id)
+force_synchronization(import_id)
+create_synchronization(url, interval, sync_options={})
+delete_synchronization(import_id)
+```
+
+## Config reference
+
+If you want to use the gem in dry run mode (no calls actually made to the CartoDB API), set:
+
+```ruby
+Cartowrap.configure do |config|
+  config.dry_run = true
+end
+```
+
 ## Contributing
-Contribution directions go here.
+Feel free to contribute pull requests are welcome.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -4,14 +4,8 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = 'Cartowrap'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec'
 end
-
-Bundler::GemHelper.install_tasks

data/lib/cartowrap/api.rb

@@ -3,6 +3,7 @@ module Cartowrap
     def initialize(api_key = nil, account = nil)
       @api_key = api_key || Cartowrap.config.api_key
       @account = account || Cartowrap.config.account
+      @dry_run = Cartowrap.config.dry_run || false
       @credentials = {}
       @credentials['api_key'] = @api_key
       @credentials['account'] = @account
@@ -84,11 +85,13 @@ module Cartowrap
 
     def validate_sync_options(sync_options)
       valid_options = [:type_guessing, :quoted_fields_guessing, :content_guessing]
-      sync_options = sync_options.map{|o| ((valid_options.include? o[0]) && !!o[1] == o[1]) ? o : nil}.compact.to_h
+      sync_options = sync_options.map { |o| ((valid_options.include? o[0]) && !!o[1] == o[1]) ? o : nil }.compact.to_h
       sync_options
     end
 
     def make_call(options)
+      return fake_response if @dry_run
+
       result = Cartowrap.make_request(options, credentials)
       unless check_errors(result.status.to_i, result.body)
         MultiJson.load("[#{result.body.to_s}]")[0]
@@ -99,18 +102,22 @@ module Cartowrap
 
     def check_errors(status, body)
       case status
-      when 500
-        initialize_options
-        raise Cartowrap::ServerError.new(status, '')
-      when 401
-        initialize_options
-        raise Cartowrap::NoTokenError.new(status, body)
-      when 404
-        initialize_options
-        raise Cartowrap::NotFoundError.new(status, '')
-      else
-        return false
+        when 500
+          initialize_options
+          raise Cartowrap::ServerError.new(status, '')
+        when 401
+          initialize_options
+          raise Cartowrap::NoTokenError.new(status, body)
+        when 404
+          initialize_options
+          raise Cartowrap::NotFoundError.new(status, '')
+        else
+          return false
       end
     end
+
+    def fake_response
+      Cartowrap::HTTPService::Response.new(200, "", "")
+    end
   end
 end

data/lib/cartowrap/version.rb

@@ -1,3 +1,3 @@
 module Cartowrap
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/cases/api_spec.rb

@@ -32,3 +32,37 @@ describe "Cartowrap::API" do
     @service.delete_synchronization("import_id")
   end
 end
+
+
+
+describe "Cartowrap::API" do
+  before(:each) do
+    Cartowrap.config.dry_run = true
+    @service = Cartowrap::API.new()
+  end
+  it "dry runs query requests" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.send_query('anything')
+  end
+  it "dry runs synchronizations requests" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.get_synchronizations
+  end
+  it "dry runs checks for synchronization status" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.check_synchronization("import_id")
+  end
+  it "dry runs synchronization forces" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.force_synchronization("import_id")
+  end
+  it "dry runs synchronization creates" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.create_synchronization("url", 900)
+  end
+  it "dry runs synchronization delete" do
+    expect(Cartowrap).to_not receive(:make_request)
+    @service.delete_synchronization("import_id")
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'simplecov'
-SimpleCov.start
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cartowrap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vizzuality
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="