rubyidescat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05f8e4732bc8763f258891d85ac85b728a3183bf
+  data.tar.gz: b874249990b868818d811e7df22d6cdda740b174
+SHA512:
+  metadata.gz: 9522bb426c8ee377f229f19b7e36a768fb117903efb1e5e97991b0e48b9af6a34b897204e9f883384b4bad48e65ca148165d52d93276b7a672de05a6bbf372eb
+  data.tar.gz: 7248d2fa3158e23a09def5dfe04bad244a5cb52067b81cf7bf8bfc525f51410f72e88a11744f898785c7845492cef68053d336ff0c0cb10d88ebb16118230373

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/fixtures
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joan Roig
+
+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,30 @@
+# Rubyidescat
+
+TODO: Write a gem description
+test
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubyidescat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubyidescat
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/rubyidescat.rb

@@ -0,0 +1,7 @@
+require "rubyidescat/version"
+require 'rubyidescat/client'
+
+module Rubyidescat
+  require "httparty"
+  # Your code goes here...
+end

data/lib/rubyidescat/client.rb

@@ -0,0 +1,33 @@
+module Rubyidescat
+  class Client
+    BASE_URL = 'http://api.idescat.cat/'
+
+    def request_url
+      URI.escape(@request_url)
+    end
+
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
+    end
+
+    def poblacio(version, format, operation, params = {})
+      @format = format
+      @version = version
+      @operation = operation
+      @params = params
+      @request_url = BASE_URL + 'pob/' + @version + '/' + @operation + '.' + @format
+      @request_url += '?p=' + @params.map{|k,v|"#{k}/#{[v].flatten.join(",")}"}.join(";") unless @params.empty?
+      make_call
+    end
+
+    private
+
+    def make_call
+      response = HTTParty.get self.request_url
+      return JSON.parse response.body
+    end
+
+  end
+end

data/lib/rubyidescat/version.rb

@@ -0,0 +1,3 @@
+module Rubyidescat
+  VERSION = "0.0.1"
+end

data/rubyidescat.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubyidescat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubyidescat"
+  spec.version       = Rubyidescat::VERSION
+  spec.authors       = ["Joan Roig Arderiu"]
+  spec.email         = ["roigarderiu@gmail.com"]
+  spec.description   = %q{Wrapper for the Idescat API}
+  spec.summary       = %q{Wrapper for the Idescat API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_dependency "httparty"
+end

data/spec/base_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rubyidescat do
+  it 'should have a version' do
+    Rubyidescat::VERSION.should_not be_nil 
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+
+describe Rubyidescat::Client do
+  describe 'initialize' do
+    it 'creates a new client' do
+      expect { Rubyidescat::Client.new }.to_not raise_error
+    end
+
+    it 'should have a base url for the API' do
+      #expect { Rubyidescat::Client }.to be_const_defined :BASE_URL
+    end
+  end
+  
+  let(:client) { Rubyidescat::Client.new }
+  describe 'poblacio' do
+
+    describe 'sug' do
+      it 'should set format correctly' do
+        VCR.use_cassette('empty sug') do
+          client.poblacio('v1','json','sug')
+          expect(client.instance_variable_get('@format')).to eq('json')
+        end
+      end
+
+      it 'should set version correctly' do
+        VCR.use_cassette('empty sug') do
+          client.poblacio('v1','json','sug')
+          expect(client.instance_variable_get('@version')).to eq('v1')
+        end
+      end
+
+      it 'should set operation correctly' do
+        VCR.use_cassette('empty sug') do
+          client.poblacio('v1','json','sug')
+          expect(client.instance_variable_get('@operation')).to eq('sug')
+        end
+      end
+
+      it 'should set request url correctly' do
+        VCR.use_cassette('torrelles sug') do
+          results = client.poblacio('v1','json','sug', { 'q' => 'torrelles' })
+          expect(client.request_url).to eq('http://api.idescat.cat/pob/v1/sug.json?p=q/torrelles')
+        end
+      end
+
+      it 'should accept one parameter and return results' do
+        VCR.use_cassette('torrelles sug') do
+          results = client.poblacio('v1','json','sug', { 'q' => 'torrelles' })
+          expect(results).to eq(["torrelles",["Torrelles de Foix","Torrelles de Llobregat"]])
+        end
+      end
+
+      it 'should accept several extra parameters and return results' do
+        VCR.use_cassette('sug tipus com "barc"') do
+          results = client.poblacio('v1','json','sug', { 'q' => 'barc', 'tipus' => 'com' })
+          expect(results).to eq(["barc",["Barcelonès"]])
+        end
+      end
+
+      it 'should accept multiple parameters with multiple values and return results' do
+        VCR.use_cassette('sug multiple parameters and values') do
+          results = client.poblacio('v1','json','sug', { 'q' => 'ab', 'tipus' => ['mun','np'] })
+          expect(results).to eq(["ab",["Abella","Abella de la Conca","Abella, l'","Abrera"]])
+        end
+      end
+    end
+
+    describe 'cerca' do
+      it 'should set operation correctly' do
+        VCR.use_cassette('empty sug') do
+          client.poblacio('v1','json','cerca')
+          expect(client.instance_variable_get('@operation')).to eq('cerca')
+        end
+      end
+
+      it 'should set request url correctly' do
+        VCR.use_cassette('torrelles cerca') do
+          results = client.poblacio('v1','json','cerca', { 'q' => 'torrelles' })
+          expect(client.request_url).to eq('http://api.idescat.cat/pob/v1/cerca.json?p=q/torrelles')
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubyidescat'
+require 'vcr'
+require 'support/vcr'

data/spec/support/vcr.rb

@@ -0,0 +1,4 @@
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rubyidescat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joan Roig Arderiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+  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: vcr
+  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: webmock
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for the Idescat API
+email:
+- roigarderiu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubyidescat.rb
+- lib/rubyidescat/client.rb
+- lib/rubyidescat/version.rb
+- rubyidescat.gemspec
+- spec/base_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+homepage: ''
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Idescat API
+test_files:
+- spec/base_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb