api_geo_client 1.0.0

data/docs/Region.md

@@ -0,0 +1,9 @@
+# ApiGeoClient::Region
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code de la région | [optional] 
+**nom** | **String** | Nom de la région | [optional] 
+
+

data/docs/RgionsApi.md

@@ -0,0 +1,159 @@
+# ApiGeoClient::RgionsApi
+
+All URIs are relative to *https://geo.api.gouv.fr*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**regions_code_departements_get**](RgionsApi.md#regions_code_departements_get) | **GET** /regions/{code}/departements | Renvoi les départements d'une région
+[**regions_code_get**](RgionsApi.md#regions_code_get) | **GET** /regions/{code} | Récupérer les informations concernant une région
+[**regions_get**](RgionsApi.md#regions_get) | **GET** /regions | Recherche des régions
+
+
+# **regions_code_departements_get**
+> Departement regions_code_departements_get(code, opts)
+
+Renvoi les départements d'une région
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::RgionsApi.new
+
+code = 'code_example' # String | Code de la région
+
+opts = { 
+  fields: ['[\"nom\",\"code\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Renvoi les départements d'une région
+  result = api_instance.regions_code_departements_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling RgionsApi->regions_code_departements_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code de la région | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;]]
+
+### Return type
+
+[**Departement**](Departement.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **regions_code_get**
+> Departement regions_code_get(code, opts)
+
+Récupérer les informations concernant une région
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::RgionsApi.new
+
+code = 'code_example' # String | Code de la région
+
+opts = { 
+  fields: ['[\"nom\",\"code\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Récupérer les informations concernant une région
+  result = api_instance.regions_code_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling RgionsApi->regions_code_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code de la région | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;]]
+
+### Return type
+
+[**Departement**](Departement.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **regions_get**
+> Array&lt;Region&gt; regions_get(opts)
+
+Recherche des régions
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::RgionsApi.new
+
+opts = { 
+  code: 'code_example', # String | Code de la région
+  nom: 'nom_example', # String | Nom de la région
+  fields: ['[\"nom\",\"code\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Recherche des régions
+  result = api_instance.regions_get(opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling RgionsApi->regions_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code de la région | [optional] 
+ **nom** | **String**| Nom de la région | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;]]
+
+### Return type
+
+[**Array&lt;Region&gt;**](Region.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/api_geo_client.rb

@@ -0,0 +1,46 @@
+=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
+
+# Common files
+require 'api_geo_client/api_client'
+require 'api_geo_client/api_error'
+require 'api_geo_client/version'
+require 'api_geo_client/configuration'
+
+# Models
+require 'api_geo_client/models/commune'
+require 'api_geo_client/models/departement'
+require 'api_geo_client/models/error'
+require 'api_geo_client/models/region'
+
+# APIs
+require 'api_geo_client/api/communes_api'
+require 'api_geo_client/api/dpartements_api'
+require 'api_geo_client/api/rgions_api'
+
+module ApiGeoClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ApiGeoClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/api_geo_client/api/communes_api.rb

@@ -0,0 +1,245 @@
+=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
+
+require 'uri'
+
+module ApiGeoClient
+  class CommunesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Récupérer les informations concernant une commune
+    # @param code Code INSEE de la commune
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to ["nom","code","codesPostaux","codeDepartement","codeRegion","population"])
+    # @option opts [String] :format Format de réponse attendu (default to json)
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique (default to centre)
+    # @return [Commune]
+    def communes_code_get(code, opts = {})
+      data, _status_code, _headers = communes_code_get_with_http_info(code, opts)
+      data
+    end
+
+    # Récupérer les informations concernant une commune
+    # @param code Code INSEE de la commune
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse
+    # @option opts [String] :format Format de réponse attendu
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique
+    # @return [Array<(Commune, Fixnum, Hash)>] Commune data, response status code and response headers
+    def communes_code_get_with_http_info(code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommunesApi.communes_code_get ...'
+      end
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling CommunesApi.communes_code_get"
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code', 'codesPostaux', 'centre', 'surface', 'contour', 'codeDepartement', 'departement', 'codeRegion', 'region', 'population'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of nom, code, codesPostaux, centre, surface, contour, codeDepartement, departement, codeRegion, region, population'
+      end
+      if @api_client.config.client_side_validation && opts[:'format'] && !['json', 'geojson'].include?(opts[:'format'])
+        fail ArgumentError, 'invalid value for "format", must be one of json, geojson'
+      end
+      if @api_client.config.client_side_validation && opts[:'geometry'] && !['centre', 'contour'].include?(opts[:'geometry'])
+        fail ArgumentError, 'invalid value for "geometry", must be one of centre, contour'
+      end
+      # resource path
+      local_var_path = '/communes/{code}'.sub('{' + 'code' + '}', code.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
+      query_params[:'geometry'] = opts[:'geometry'] if !opts[:'geometry'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Commune')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommunesApi#communes_code_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Recherche des communes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code_postal Code postal associé
+    # @option opts [Float] :lat Latitude (en degrés)
+    # @option opts [Float] :lon Longitude (en degrés)
+    # @option opts [String] :nom Nom de la commune
+    # @option opts [String] :boost Mode de boost de la recherche par nom
+    # @option opts [String] :code Code de la commune
+    # @option opts [String] :code_departement Code du département associé
+    # @option opts [String] :code_region Code de la région associée
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to ["nom","code","codesPostaux","codeDepartement","codeRegion","population"])
+    # @option opts [String] :format Format de réponse attendu (default to json)
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique (default to centre)
+    # @return [Array<Commune>]
+    def communes_get(opts = {})
+      data, _status_code, _headers = communes_get_with_http_info(opts)
+      data
+    end
+
+    # Recherche des communes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code_postal Code postal associé
+    # @option opts [Float] :lat Latitude (en degrés)
+    # @option opts [Float] :lon Longitude (en degrés)
+    # @option opts [String] :nom Nom de la commune
+    # @option opts [String] :boost Mode de boost de la recherche par nom
+    # @option opts [String] :code Code de la commune
+    # @option opts [String] :code_departement Code du département associé
+    # @option opts [String] :code_region Code de la région associée
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse
+    # @option opts [String] :format Format de réponse attendu
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique
+    # @return [Array<(Array<Commune>, Fixnum, Hash)>] Array<Commune> data, response status code and response headers
+    def communes_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommunesApi.communes_get ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code', 'codesPostaux', 'centre', 'surface', 'contour', 'codeDepartement', 'departement', 'codeRegion', 'region', 'population'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of nom, code, codesPostaux, centre, surface, contour, codeDepartement, departement, codeRegion, region, population'
+      end
+      if @api_client.config.client_side_validation && opts[:'format'] && !['json', 'geojson'].include?(opts[:'format'])
+        fail ArgumentError, 'invalid value for "format", must be one of json, geojson'
+      end
+      if @api_client.config.client_side_validation && opts[:'geometry'] && !['centre', 'contour'].include?(opts[:'geometry'])
+        fail ArgumentError, 'invalid value for "geometry", must be one of centre, contour'
+      end
+      # resource path
+      local_var_path = '/communes'
+
+      # query parameters
+      query_params = {}
+      query_params[:'codePostal'] = opts[:'code_postal'] if !opts[:'code_postal'].nil?
+      query_params[:'lat'] = opts[:'lat'] if !opts[:'lat'].nil?
+      query_params[:'lon'] = opts[:'lon'] if !opts[:'lon'].nil?
+      query_params[:'nom'] = opts[:'nom'] if !opts[:'nom'].nil?
+      query_params[:'boost'] = opts[:'boost'] if !opts[:'boost'].nil?
+      query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
+      query_params[:'codeDepartement'] = opts[:'code_departement'] if !opts[:'code_departement'].nil?
+      query_params[:'codeRegion'] = opts[:'code_region'] if !opts[:'code_region'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
+      query_params[:'geometry'] = opts[:'geometry'] if !opts[:'geometry'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Commune>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommunesApi#communes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Renvoi les communes d'un département
+    # @param code Code du département
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to ["nom","code","codesPostaux","codeDepartement","codeRegion","population"])
+    # @option opts [String] :format Format de réponse attendu (default to json)
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique (default to centre)
+    # @return [Commune]
+    def departements_code_communes_get(code, opts = {})
+      data, _status_code, _headers = departements_code_communes_get_with_http_info(code, opts)
+      data
+    end
+
+    # Renvoi les communes d&#39;un département
+    # @param code Code du département
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse
+    # @option opts [String] :format Format de réponse attendu
+    # @option opts [String] :geometry Géométrie à utiliser pour la sortie géographique
+    # @return [Array<(Commune, Fixnum, Hash)>] Commune data, response status code and response headers
+    def departements_code_communes_get_with_http_info(code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommunesApi.departements_code_communes_get ...'
+      end
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling CommunesApi.departements_code_communes_get"
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code', 'codesPostaux', 'centre', 'surface', 'contour', 'codeDepartement', 'departement', 'codeRegion', 'region', 'population'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of nom, code, codesPostaux, centre, surface, contour, codeDepartement, departement, codeRegion, region, population'
+      end
+      if @api_client.config.client_side_validation && opts[:'format'] && !['json', 'geojson'].include?(opts[:'format'])
+        fail ArgumentError, 'invalid value for "format", must be one of json, geojson'
+      end
+      if @api_client.config.client_side_validation && opts[:'geometry'] && !['centre', 'contour'].include?(opts[:'geometry'])
+        fail ArgumentError, 'invalid value for "geometry", must be one of centre, contour'
+      end
+      # resource path
+      local_var_path = '/departements/{code}/communes'.sub('{' + 'code' + '}', code.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
+      query_params[:'geometry'] = opts[:'geometry'] if !opts[:'geometry'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Commune')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommunesApi#departements_code_communes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end