epitech-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 269374dfa8ca04aafb52fe4365b804e097e59bc6
+  data.tar.gz: cb60f0bdb4938fc17ed74fc59ecaf6fe7f4c0a6e
+SHA512:
+  metadata.gz: 24f688fdfc5b8dfd365fa8bd589d38a95adeca13869090e8ade2fb964afc2ef5f368f6fba1d7145eeb527e17a537c9c24f9aa27d65880c41bb81c55b509e3516
+  data.tar.gz: 513d08f5f63e318216db2bf1e25ee76bac6c6bd1eedec8882b69880e0b6f470a1c716bb59c6ff30204fa3e03f3558ede5a78c5629fb32e63877b20675351080b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 antoin_m
+
+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,29 @@
+# Epitech::Api
+
+This gem can be used to call paysdu42.fr's API through Ruby.
+You can get informations about all Ionis users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'epitech-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epitech-api
+
+## Usage
+
+    require 'epitech-api'
+
+    c = Epitech::Api::Connection.new('exampl_e', 'z9VH52jb')
+    if c.is_login? 'antoin_m'
+        puts "Hello, I'm #{c.get_name('antoin_m')}"
+    end
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/epitech-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "epitech-api"
+  spec.version       = Epitech::Api::VERSION
+  spec.authors       = ["antoin_m"]
+  spec.email         = ["michel1.antoine@epitech.eu"]
+  spec.summary       = %q{A simple gem to use Ionis' API.}
+  spec.description   = %q{This gem can be used to call paysdu42.fr's API through Ruby. You can get informations about all Ionis users.}
+  spec.homepage      = "https://github.com/antoin-m/epitech-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+end

data/lib/Exceptions/errors.rb

@@ -0,0 +1,19 @@
+# API error's namespace
+module Epitech::Api::Errors
+
+  # Top of the error tree
+  class Epitech::Api::Errors::Base < RuntimeError
+  end
+
+  # Error thrown when a parameter is missing in the request
+  class Epitech::Api::Errors::MissingParameters < Epitech::Api::Errors::Base
+  end
+
+  # Error thrown when the request ask for an unknown action
+  class Epitech::Api::Errors::UnknownAction < Epitech::Api::Errors::Base
+  end
+
+  # Error thrown when using a bad login/password combination
+  class Epitech::Api::Errors::AuthFail < Epitech::Api::Errors::Base
+  end
+end

data/lib/api/check_api.rb

@@ -0,0 +1,26 @@
+module Epitech::Api::CheckApi
+  # Check for a good login/password combination (those given to Epitech::Api::Connection.new)
+  # @return [Boolean] True (Raise a Epitech::Api::Errors::AuthFail otherwise)
+  def check_auth
+    call_api(action: 'login')
+    true
+  end
+
+  # Test if the parameter is an existing ionis login
+  # @param login [String] The login to test
+  def is_login?(login)
+    json = call_api(action: 'is_login', login: login)
+    return false if json['state'] != 'OK'
+    true
+  end
+
+  # Test if the parameters are an existing login / PPP combination
+  # @param login  [String] Login to test
+  # @param pwd    [String] Password to test
+  # @return       [Boolean]
+  def check_password(login, pwd)
+    json = call_api(action: 'check_password', login: login, password: pwd)
+    return false if json['state'] != 'OK'
+    true
+  end
+end

data/lib/api/connection.rb

@@ -0,0 +1,41 @@
+require_relative 'check_api'
+require_relative 'info_api'
+require_relative 'search_api'
+
+# Class provided to maintain a connection to the API
+class Epitech::Api::Connection
+  include Epitech::Api
+
+  include Epitech::Api::CheckApi
+  include Epitech::Api::InfoApi
+  include Epitech::Api::SearchApi
+
+  # Constructor
+  # @param login  [String]  Your ionis login
+  # @param pwd    [String]  Your ionis password
+  # @return       [Boolean] True if the connection was successful (Raise a Epitech::Api::Errors::AuthFail otherwise)
+  def initialize(login, pwd)
+    @login = login
+    @pwd = pwd
+    connect!
+  end
+
+  # Overloading of Epitech::Api::call_api, will use instance variables
+  # for auth_login and auth_password
+  def call_api(opts={})
+    opts[:auth_login] ||= @login
+    opts[:auth_password] ||= @pwd
+    super(opts)
+  end
+
+  # Try to connect to the API with the instance variables
+  def connect!
+    @connected = check_auth
+  end
+
+  # @return True if the connection is established, false otherwise
+  def is_connected?
+    @connected
+  end
+
+end

data/lib/api/info_api.rb

@@ -0,0 +1,26 @@
+module Epitech::Api::InfoApi
+
+  # Get a Ionis login from a UID
+  # @param uid  [String, Integer] The UID to look for
+  # @return     [String]          The corresponding login
+  def get_login_from_uid(uid)
+    call_api(action: 'get_login_from_uid', uid: uid)['login']
+  end
+
+  %w(uid name group school promo city plan phone).each do |request|
+    class_eval %Q(def get_#{request}(login)
+      call_api(action: "get_#{request}", login: login)['#{request}']
+    end)
+  end
+
+  # Get all the infos about a Ionis login
+  # Each information can be retrieved separately through the get_xxx method
+  # example:
+  #           connection.get_name('exampl_e')
+  #           connection.get_uid('exampl_e')
+  # @param login  [String]  The login to look for
+  # @return       [Hash]    The corresponding infos
+  def get_infos(login)
+    call_api(action: 'get_infos', login: login)
+  end
+end

data/lib/api/search_api.rb

@@ -0,0 +1,20 @@
+module Epitech::Api::SearchApi
+
+  # Used to search across the Ionis users
+  # @param query    [String]    First/Last Name or Login (or a part of it)
+  #                             of who you are looking for.
+  # @return         [Array]     An Array of logins
+  def search(query)
+    call_api(action: 'search', query: query)
+  end
+
+  # Used to search logins across the Ionis users through 3 criterias :
+  # * Schoolname
+  # * Promo
+  # * City
+  # @param  opts  [Hash]  A Hash that should contain at least one of the 3 criterias
+  # @return       [Array] An Array of logins
+  def get_logins(opts={})
+    call_api(action: 'get_logins', school: opts[:school], promo: opts[:promo], city: opts[:city])
+  end
+end

data/lib/api/version.rb

@@ -0,0 +1,6 @@
+module Epitech
+  module Api
+    # Gem version
+    VERSION = "1.0.0"
+  end
+end

data/lib/epitech-api.rb

@@ -0,0 +1,14 @@
+require 'version'
+require 'open-uri'
+require 'json'
+
+# Gem's global namespace
+module Epitech
+  module Api
+    # JSON API URL
+    BASE_URL = 'http://ws.paysdu42.fr/JSON/?'
+  end
+end
+
+require_relative 'utils'
+require_relative 'api/connection'

data/lib/utils.rb

@@ -0,0 +1,42 @@
+require_relative './Exceptions/errors'
+
+module Epitech::Api
+
+  # Used to call the webservice
+  # @param opts [Hash] Hash used as URL params, formatted by {#hash_to_req}
+  # @return What the Web API is supposed to return
+  def call_api(opts={})
+    tmp = open(URI(URI.escape(BASE_URL + hash_to_req(opts)))).read
+    tmp = tmp.split("\n").drop(1).join("\n") while tmp.start_with?(%Q(SSH connection failed.))
+    json = JSON.parse(tmp)
+    raise get_error_class(json['error']) if json['error'] != 'none'
+    json['result']
+  end
+
+  private
+
+  def get_error_class(str)
+    to_class "Epitech::Api::Errors::#{to_camelcase(str)}"
+  end
+
+  def to_camelcase(str)
+    str.split('_').collect(&:capitalize).join
+  end
+
+  def to_class(str)
+    Object.const_get str
+  end
+
+  # Transform a Hash to Web API URL params
+  # @param hash [Hash]
+  # @return [String]  formatted from 'hash' as follow:
+  #                   { action: 'connect', login: 'exampl_e' } becomes
+  #                   "action=connect&login=exampl_e"
+  def hash_to_req(hash)
+    req = ''
+    hash.each_pair do |key, val|
+      req << key.to_s << '=' << val.to_s << '&' unless val.nil?
+    end
+    req.chop
+  end
+end

data/lib/version.rb

@@ -0,0 +1,6 @@
+module Epitech
+  module Api
+    # Gem version
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: epitech-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- antoin_m
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: This gem can be used to call paysdu42.fr's API through Ruby. You can
+  get informations about all Ionis users.
+email:
+- michel1.antoine@epitech.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- epitech-api.gemspec
+- lib/Exceptions/errors.rb
+- lib/api/check_api.rb
+- lib/api/connection.rb
+- lib/api/info_api.rb
+- lib/api/search_api.rb
+- lib/api/version.rb
+- lib/epitech-api.rb
+- lib/utils.rb
+- lib/version.rb
+homepage: https://github.com/antoin-m/epitech-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.0.14
+signing_key: 
+specification_version: 4
+summary: A simple gem to use Ionis' API.
+test_files: []
+has_rdoc: