api_geo_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7f9c76f67edc6ce2859ebaae91229b512be3d927826a91cccac30b79edade45
+  data.tar.gz: 7901c108fbc64050a9b653ee76eaa719cee7564fe021c9cc8cc48de4190436c8
+SHA512:
+  metadata.gz: b9633bc688e1c815e95e80b2bc0822c12c1b9abfa3cbbcf059ace24f50422b46d51f5ea9000d17bb3eeccf68f55b1cafe28804617cb97bcd0891ddc53e2cd4fd
+  data.tar.gz: '0536188a4857bf3a9b74f5c86cf23c278fa77d3f89e921c4900a9139b4be23c0b4ec665e7ce353e6609cce994535bac6f98669602ac4ca42ef7a48c2155d4674'

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    api_geo_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.1)
+    hashdiff (0.4.0)
+    json (2.2.0)
+    public_suffix (3.1.0)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    sys-uname (1.0.4)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_geo_client!
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cashbee
+
+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,106 @@
+# api_geo_client
+
+ApiGeoClient - the Ruby gem for the API Référentiels géographiques
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0-beta
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build api_geo_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./api_geo_client-1.0.0.gem
+```
+(for development, run `gem install --dev ./api_geo_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'api_geo_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'api_geo_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::CommunesApi.new
+
+code = 'code_example' # String | Code INSEE de la commune
+
+opts = { 
+  fields: ['[\"nom\",\"code\",\"codesPostaux\",\"codeDepartement\",\"codeRegion\",\"population\"]'], # Array<String> | Liste des champs souhaités dans la réponse
+  format: 'json', # String | Format de réponse attendu
+  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
+}
+
+begin
+  #Récupérer les informations concernant une commune
+  result = api_instance.communes_code_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling CommunesApi->communes_code_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://geo.api.gouv.fr*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApiGeoClient::CommunesApi* | [**communes_code_get**](docs/CommunesApi.md#communes_code_get) | **GET** /communes/{code} | Récupérer les informations concernant une commune
+*ApiGeoClient::CommunesApi* | [**communes_get**](docs/CommunesApi.md#communes_get) | **GET** /communes | Recherche des communes
+*ApiGeoClient::CommunesApi* | [**departements_code_communes_get**](docs/CommunesApi.md#departements_code_communes_get) | **GET** /departements/{code}/communes | Renvoi les communes d'un département
+*ApiGeoClient::DpartementsApi* | [**departements_code_communes_get**](docs/DpartementsApi.md#departements_code_communes_get) | **GET** /departements/{code}/communes | Renvoi les communes d'un département
+*ApiGeoClient::DpartementsApi* | [**departements_code_get**](docs/DpartementsApi.md#departements_code_get) | **GET** /departements/{code} | Récupérer les informations concernant un département
+*ApiGeoClient::DpartementsApi* | [**departements_get**](docs/DpartementsApi.md#departements_get) | **GET** /departements | Recherche des départements
+*ApiGeoClient::DpartementsApi* | [**regions_code_departements_get**](docs/DpartementsApi.md#regions_code_departements_get) | **GET** /regions/{code}/departements | Renvoi les départements d'une région
+*ApiGeoClient::RgionsApi* | [**regions_code_departements_get**](docs/RgionsApi.md#regions_code_departements_get) | **GET** /regions/{code}/departements | Renvoi les départements d'une région
+*ApiGeoClient::RgionsApi* | [**regions_code_get**](docs/RgionsApi.md#regions_code_get) | **GET** /regions/{code} | Récupérer les informations concernant une région
+*ApiGeoClient::RgionsApi* | [**regions_get**](docs/RgionsApi.md#regions_get) | **GET** /regions | Recherche des régions
+
+
+## Documentation for Models
+
+ - [ApiGeoClient::Commune](docs/Commune.md)
+ - [ApiGeoClient::Departement](docs/Departement.md)
+ - [ApiGeoClient::Error](docs/Error.md)
+ - [ApiGeoClient::Region](docs/Region.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'rspec/core/rake_task'
+  require 'bundler/gem_tasks'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/api_geo_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#API Référentiels géographiques
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0-beta
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.5
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "api_geo_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api_geo_client"
+  s.version     = ApiGeoClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Armand Mégrot"]
+  s.email       = ["armand.megrot@cashbee.fr"]
+  s.homepage    = "https://github.com/cashbee-team/api_geo_client"
+  s.summary     = "API Géo Ruby Gem"
+  s.description = "API Géo. More info at https://api.gouv.fr/api/api-geo.html. Generated by Cashbee https://www.cashbee.fr"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/api_geo_spec.yml

@@ -0,0 +1,413 @@
+swagger: '2.0'
+info:
+  title: API Référentiels géographiques
+  version: '1.0.0-beta'
+host: geo.api.gouv.fr
+schemes:
+  - https
+produces:
+  - application/json
+parameters:
+  communeFieldsParam:
+    name: fields
+    in: query
+    description: Liste des champs souhaités dans la réponse
+    type: array
+    items:
+      type: string
+      enum:
+        - nom
+        - code
+        - codesPostaux
+        - centre
+        - surface
+        - contour
+        - codeDepartement
+        - departement
+        - codeRegion
+        - region
+        - population
+    collectionFormat: csv
+    default:
+      - nom
+      - code
+      - codesPostaux
+      - codeDepartement
+      - codeRegion
+      - population
+  departementFieldsParam:
+    name: fields
+    in: query
+    description: Liste des champs souhaités dans la réponse
+    type: array
+    items:
+      type: string
+      enum:
+        - nom
+        - code
+        - codeRegion
+        - region
+    collectionFormat: csv
+    default:
+      - nom
+      - code
+      - codeRegion
+  regionFieldsParam:
+    name: fields
+    in: query
+    description: Liste des champs souhaités dans la réponse
+    type: array
+    items:
+      type: string
+      enum:
+        - nom
+        - code
+    collectionFormat: csv
+    default:
+      - nom
+      - code
+  formatParam:
+    name: format
+    in: query
+    description: Format de réponse attendu
+    type: string
+    enum: ['json', 'geojson']
+    default: json
+  communeGeometryParam:
+    name: geometry
+    in: query
+    description: Géométrie à utiliser pour la sortie géographique
+    type: string
+    enum: ['centre', 'contour']
+    default: centre
+  limitParam:
+    name: limit
+    in: query
+    description: Nombre d'éléments à retourner
+    type: integer
+    format: int32
+    default: 0
+paths:
+  /communes:
+    get:
+      summary: Recherche des communes
+      tags:
+        - Communes
+      parameters:
+        - name: codePostal
+          in: query
+          description: Code postal associé
+          type: string
+        - name: lat
+          in: query
+          description: Latitude (en degrés)
+          type: number
+          format: float
+        - name: lon
+          in: query
+          description: Longitude (en degrés)
+          type: number
+          format: float
+        - name: nom
+          in: query
+          description: Nom de la commune
+          type: string
+        - name: boost
+          in: query
+          description: Mode de boost de la recherche par nom
+          type: string
+        - name: code
+          in: query
+          description: Code de la commune
+          type: string
+        - name: codeDepartement
+          in: query
+          description: Code du département associé
+          type: string
+        - name: codeRegion
+          in: query
+          description: Code de la région associée
+          type: string
+        - $ref: '#/parameters/communeFieldsParam'
+        - $ref: '#/parameters/formatParam'
+        - $ref: '#/parameters/communeGeometryParam'
+      responses:
+        200:
+          description: Liste de communes
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Commune'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+
+
+  /communes/{code}:
+    get:
+      summary: Récupérer les informations concernant une commune
+      tags:
+        - Communes
+      parameters:
+        - name: code
+          in: path
+          description: Code INSEE de la commune
+          required: true
+          type: string
+        - $ref: '#/parameters/communeFieldsParam'
+        - $ref: '#/parameters/formatParam'
+        - $ref: '#/parameters/communeGeometryParam'
+      responses:
+        200:
+          description: Informations concernant une commune
+          schema:
+            $ref: '#/definitions/Commune'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+        404:
+          description: Commune introuvable
+          schema:
+            $ref: '#/definitions/Error'
+
+  /departements:
+      get:
+        summary: Recherche des départements
+        tags:
+          - Départements
+        parameters:
+          - name: code
+            in: query
+            description: Code du département
+            type: string
+          - name: codeRegion
+            in: query
+            description: Code région associé
+            type: string
+          - name: nom
+            in: query
+            description: Nom du département
+            type: string
+          - $ref: '#/parameters/departementFieldsParam'
+        responses:
+          200:
+            description: Le ou les départements
+            schema:
+              type: array
+              items:
+                $ref: '#/definitions/Departement'
+          400:
+            description: Erreur. Requête mal formée
+            schema:
+              $ref: '#/definitions/Error'
+
+  /departements/{code}:
+    get:
+      summary: Récupérer les informations concernant un département
+      tags:
+        - Départements
+      parameters:
+        - name: code
+          in: path
+          description: Code du département
+          required: true
+          type: string
+        - $ref: '#/parameters/departementFieldsParam'
+      responses:
+        200:
+          description: Informations concernant un département
+          schema:
+            $ref: '#/definitions/Departement'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+        404:
+          description: Département introuvable
+          schema:
+            $ref: '#/definitions/Error'
+
+  /departements/{code}/communes:
+    get:
+      summary: Renvoi les communes d'un département
+      tags:
+        - Départements
+        - Communes
+      parameters:
+        - name: code
+          in: path
+          description: Code du département
+          required: true
+          type: string
+        - $ref: '#/parameters/communeFieldsParam'
+        - $ref: '#/parameters/formatParam'
+        - $ref: '#/parameters/communeGeometryParam'
+      responses:
+        200:
+          description: Liste des communes du département
+          schema:
+            $ref: '#/definitions/Commune'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+        404:
+          description: Département introuvable
+          schema:
+            $ref: '#/definitions/Error'
+
+  /regions:
+      get:
+        summary: Recherche des régions
+        tags:
+          - Régions
+        parameters:
+          - name: code
+            in: query
+            description: Code de la région
+            type: string
+          - name: nom
+            in: query
+            description: Nom de la région
+            type: string
+          - $ref: '#/parameters/regionFieldsParam'
+        responses:
+          200:
+            description: La ou les régions
+            schema:
+              type: array
+              items:
+                $ref: '#/definitions/Region'
+          400:
+            description: Erreur. Requête mal formée
+            schema:
+              $ref: '#/definitions/Error'
+
+  /regions/{code}:
+    get:
+      summary: Récupérer les informations concernant une région
+      tags:
+        - Régions
+      parameters:
+        - name: code
+          in: path
+          description: Code de la région
+          required: true
+          type: string
+        - $ref: '#/parameters/regionFieldsParam'
+      responses:
+        200:
+          description: Informations concernant la région
+          schema:
+            $ref: '#/definitions/Departement'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+        404:
+          description: Région introuvable
+          schema:
+            $ref: '#/definitions/Error'
+
+  /regions/{code}/departements:
+    get:
+      summary: Renvoi les départements d'une région
+      tags:
+        - Départements
+        - Régions
+      parameters:
+        - name: code
+          in: path
+          description: Code de la région
+          required: true
+          type: string
+        - $ref: '#/parameters/regionFieldsParam'
+      responses:
+        200:
+          description: Liste des départements de la région
+          schema:
+            $ref: '#/definitions/Departement'
+        400:
+          description: Erreur. Requête mal formée
+          schema:
+            $ref: '#/definitions/Error'
+        404:
+          description: Département introuvable
+          schema:
+            $ref: '#/definitions/Error'
+
+definitions:
+  Error:
+    type: object
+    properties:
+      code:
+        type: integer
+        description: Code HTTP de l'erreur
+      message:
+        type: string
+        description: Libellé de l'erreur
+      description:
+        type: string
+        description: Explication
+  Commune:
+    type: object
+    properties:
+      code:
+        type: string
+        description: Code INSEE de la commune
+      nom:
+        type: string
+        description: Nom de la commune
+      codesPostaux:
+        type: array
+        description: Liste des codes postaux associés à la commune
+        items:
+          type: string
+      codeDepartement:
+        type: string
+        description: Code du département associé à la commune
+      codeRegion:
+        type: string
+        description: Code de la région associée à la commune
+      departement:
+        $ref: '#/definitions/Departement'
+      region:
+        $ref: '#/definitions/Region'
+      population:
+        type: integer
+        description: Population municipale
+      surface:
+        type: number
+        format: float
+        description: Surface de la commune, en mètres-carrés
+      centre:
+        type: object
+        description: Centre de la commune (Point GeoJSON)
+      contour:
+        type: object
+        description: Contour de la commune (Polygon GeoJSON)
+  Departement:
+    type: object
+    properties:
+      code:
+        type: string
+        description: Code du département
+      nom:
+        type: string
+        description: Nom du département
+      codeRegion:
+        type: string
+        description: Code de la région
+      region:
+        $ref: '#/definitions/Region'
+  Region:
+    type: object
+    properties:
+      code:
+        type: string
+        description: Code de la région
+      nom:
+        type: string
+        description: Nom de la région