fedena_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 115c979648973760c2f3a3f6acea137101efecd2
+  data.tar.gz: 594569d491474ff420de3fa036c930823e5e0ff8
+SHA512:
+  metadata.gz: 2befd32d8b42e688ca6dea148c3d5bb360e67329c3608a78f2bea71b2701a1c4f49adfda49d5ed27acd991a752825e2c3b73f581f99f67a1248c006961565e41
+  data.tar.gz: 587e3dae4748fd767391e1c4d77716046185ba72b08f754f69e1782b49675eddd4b1f6c9d67a2db2efd58d62f437f6857cbc3feb2ab57eb5e42b4385c5d84d9b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at aboobackervyd@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Aboobacker MK
+
+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,134 @@
+# FedenaSdk
+
+Ruby wrapper for fedena api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fedena_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fedena_sdk
+
+## Usage
+
+Initialize sdk
+```ruby
+client = FedenaSdk.authenticate(
+client_id: "",
+client_secret: "",
+uri: '',
+redirect_uri: "");
+```
+
+### Generate access token
+#### Using username and password
+```ruby
+FedenaSdk.access_token_from_password('username','password','redirect_uri');
+```
+
+##### Using authcode
+
+* Get authorise url
+```ruby
+client.auth_code.authorize_url(:redirect_uri => '')
+```
+* Get auth code from url
+
+* Generate token
+```ruby
+token = client.auth_code.get_token(auth_code,{:redirect_uri => ''},:header_format=>"Token token=\"%s\"")
+```
+
+### News
+
+* Get all News
+
+```ruby
+FedenaSdk::News.all
+```
+
+### User
+
+* Get user details
+
+```ruby
+FedenaSdk::User.find('username')
+```
+
+### School
+
+* Get current school details
+
+```ruby
+FedenaSdk::School.current_school
+```
+
+### Attendance
+* Get attendance status of a student
+
+```ruby
+FedenaSdk::Attendance.show(admission_no,date=>'10-12-2014')
+```
+* Search in attendance entries
+
+```ruby
+FedenaSdk::Attendance.search(query)
+```
+
+* Marking attendance
+
+```ruby
+attendance = FedenaSdk::Attendance.new(student_admission_no: "", forenoon: "", afternoon: "", date: "", batch_name: "", reason: "")
+attendance.save
+```
+
+* Deleting attendance object
+
+```ruby
+attendance.destroy
+```
+
+* Deleting attendance entry by admission_no and date
+
+```ruby
+FedenaSdk::Attendance.destroy(admission_no,date)
+```
+### Course
+
+* Get all  courses
+
+```ruby
+FedenaSdk::Course.all
+```
+
+### Batch
+
+* Search for batches
+
+```ruby
+FedenaSdk::Batch.search(query)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tachyons/fedena-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fedena_sdk'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fedena_sdk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fedena_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fedena_sdk'
+  spec.version       = FedenaSdk::VERSION
+  spec.authors       = ['Aboobacker MK']
+  spec.email         = ['aboobackervyd@gmail.com']
+
+  spec.summary       = 'Fedena Sdk'
+  spec.description   = 'Fedena sdk'
+  spec.homepage      = 'https://github.com/tachyons/fedena-sdk-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'oauth2'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/fedena_sdk.rb

@@ -0,0 +1,36 @@
+require 'fedena_sdk/version'
+require 'fedena_sdk/errors'
+require 'fedena_sdk/client'
+require 'fedena_sdk/model'
+require 'fedena_sdk/user'
+require 'fedena_sdk/news'
+require 'fedena_sdk/school'
+require 'fedena_sdk/attendance'
+require 'fedena_sdk/employee_attendance'
+require 'fedena_sdk/course'
+require 'fedena_sdk/batch'
+require 'active_support/all'
+
+module FedenaSdk
+  class << self
+    attr_accessor :client, :access_token
+
+    def authenticate(options = {})
+      @client = FedenaSdk::Client.new options
+      @oauth2_client = @client.oauth2_client
+      @client
+    end
+
+    def access_token_from_auth_code(auth_code, redirect_uri)
+      @access_token ||= @oauth2_client.auth_code.get_token(auth_code, { redirect_uri: redirect_uri }, header_format: 'Token token="%s"')
+    end
+
+    def access_token_from_password(username, password, redirect_uri)
+      @access_token ||= @oauth2_client.password.get_token(username, password, { redirect_uri: redirect_uri }, header_format: 'Token token="%s"')
+    end
+
+    def current_user
+      FedenaSdk::User.new(@access_token.params['user_info'])
+    end
+   end
+end

data/lib/fedena_sdk/attendance.rb

@@ -0,0 +1,58 @@
+module FedenaSdk
+  class Attendance < Model
+    attr_accessor :student_admission_no, :forenoon, :afternoon, :date, :batch_name, :reason, :subject_code, :class_timing_name
+
+    def self.show(admission_no, options = {})
+      date = options[:date]
+      attendance_type = options[:attendance_type]
+      subject_code = options[:subject_code]
+      class_timing_name = options[:class_timing_name]
+      url = "/api/attendances/#{admission_no}"
+      options = { params: { attendance_type: attendance_type,
+                            date: date,
+                            subject_code: subject_code,
+                            class_timing_name: class_timing_name } }
+      hash = get(url, options)
+      new hash['attendance_detail']['attendance']
+    end
+
+    def self.search(query)
+      url = '/api/attendances'
+      params = { search: query }
+      options = { params: params }
+      hash = get(url, options)
+      hash['attendance_detail']['attendance'].map do |attendance_hash|
+        new attendance_hash
+      end
+    end
+
+    def save
+      url = '/api/attendances'
+      params = attributes_hash
+      options = { params: params }
+      hash = post(url, options)
+      new hash['attendance_detail']['attendance']
+    end
+
+    def self.create(*args)
+      attendance = Attendance.new *args
+      attendance.save
+    end
+
+    def self.destroy(admission_no, date)
+      url = "/api/attendances/#{admission_no}"
+      params = { date: date }
+      options = { params: params }
+      request(:delete, url, options)
+    end
+
+    def destroy
+      self.class.destroy(student_admission_no, date)
+    end
+
+    # Overrides
+    def attributes_hash
+      super.merge(admission_no: @student_admission_no)
+    end
+  end
+end

data/lib/fedena_sdk/batch.rb

@@ -0,0 +1,15 @@
+module FedenaSdk
+  class Batch < Model
+    attr_accessor :name, :course_code, :start_date, :end_date
+
+    def self.search(query)
+      url = '/api/batches'
+      params = { search: query }
+      options = { params: params }
+      hash = get(url, options)
+      hash['batch_detail']['batch'].map do |batch_hash|
+        new batch_hash
+      end
+    end
+  end
+end

data/lib/fedena_sdk/client.rb

@@ -0,0 +1,26 @@
+require 'oauth2'
+
+module FedenaSdk
+  class Client
+    attr_accessor :client_id, :access_token, :client_secret, :redirect_uri, :uri
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+
+    def oauth2_client
+      @client ||= OAuth2::Client.new(@client_id, @client_secret, site: @uri)
+    end
+
+    def authorize_uri
+      oauth2_client.auth_code.authorize_url(redirect_uri: @redirect_uri)
+    end
+
+    def method_missing(method, *args)
+      oauth2_client.send(method, *args)
+    end
+  end
+end

data/lib/fedena_sdk/course.rb

@@ -0,0 +1,13 @@
+module FedenaSdk
+  class Course < Model
+    attr_accessor :course_name, :course_code, :section_name, :grading_type
+
+    def self.all
+      url = '/api/courses'
+      hash = get(url)
+      hash['course_detail']['course'].map do |course_hash|
+        new course_hash
+      end
+    end
+  end
+end

data/lib/fedena_sdk/employee_attendance.rb

@@ -0,0 +1,43 @@
+module FedenaSdk
+  class EmployeeAttendance
+    attr_accessor :attendance_date, :employee_number, :leave_type, :reason, :half_day
+
+    def search(_query)
+      url = '/api/employee_attendances'
+      hash = get(url)
+      hash['attendance_detail']['attendance'].map do |attendance_hash|
+        new attendance_hash
+      end
+    end
+
+    def employee_leave_types(_query)
+      url = '/api/employee_leave_types'
+      get(url)
+    end
+
+    def save
+      url = '/api/employee_attendances'
+      params = attributes_hash
+      options = { params: params }
+      hash = post(url, options)
+      new hash['attendance_detail']['attendance']
+    end
+
+    def self.create(*args)
+      attendance = EmployeeAttendance.new *args
+      attendance.save
+    end
+
+    def self.destroy(employee_number, date)
+      url = "/api/employee_attendances/#{employee_number}"
+      params = { date: date }
+      options = { params: params }
+      request(:delete, url, options)
+    end
+
+    # Overrides
+    def attributes_hash
+      super.merge(leave_type_code: @leave_type)
+    end
+  end
+end

data/lib/fedena_sdk/errors.rb

@@ -0,0 +1,10 @@
+module FedenaSdk
+  class FedenaSdkError < StandardError
+  end
+
+  class ResourceNotFound < FedenaSdkError
+  end
+
+  class InvalidRequest < FedenaSdkError
+  end
+end

data/lib/fedena_sdk/model.rb

@@ -0,0 +1,53 @@
+module FedenaSdk
+  class Model
+    def self.attr_accessor(*args)
+      @attributes ||= []
+      @attributes.concat args
+      super(*args)
+    end
+
+    class << self
+      attr_reader :attributes
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def attributes_hash
+      attributes.map { |attribute| { attribute => send(attribute) } }.reduce({}, :merge)
+    end
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # FIXME: better name for this method
+    def self.get(url, options = {})
+      request(:get, url, options)
+    end
+
+    def self.post(url, options = {})
+      request(:post, url, options)
+    end
+
+    def self.request(verb, url, options = {})
+      xml = FedenaSdk.access_token.request(verb, url, options).body
+      Hash.from_xml xml
+    end
+
+    def post(*args)
+      self.class.post *args
+    end
+
+    def get(*args)
+      self.class.get *args
+    end
+
+    def request
+      self.class.request *args
+    end
+  end
+end

data/lib/fedena_sdk/news.rb

@@ -0,0 +1,16 @@
+module FedenaSdk
+  class News < Model
+    attr_accessor :title, :content, :author
+    def self.all(_count = nil)
+      url = '/api/news'
+      hash = get(url)
+      hash['news_detail']['news'].map do |news_hash|
+        new news_hash
+      end
+    end
+
+    def author_user
+      User.find(@author)
+    end
+  end
+end

data/lib/fedena_sdk/school.rb

@@ -0,0 +1,11 @@
+module FedenaSdk
+  class School < Model
+    attr_accessor :institute_name, :institute_address, :institute_phone, :institute_language, :institute_currency, :institute_time_zone, :image
+
+    def self.current_school
+      url = '/api/schools'
+      hash = get(url)
+      new hash['school_detail']['school']
+    end
+  end
+end

data/lib/fedena_sdk/user.rb

@@ -0,0 +1,10 @@
+module FedenaSdk
+  class User < Model
+    attr_accessor :type, :username, :email, :full_name
+    def self.find(username)
+      url = "/api/users/#{username}"
+      hash = get(url)
+      new hash['user_detail']['user']
+    end
+  end
+end

data/lib/fedena_sdk/version.rb

@@ -0,0 +1,3 @@
+module FedenaSdk
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fedena_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aboobacker MK
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Fedena sdk
+email:
+- aboobackervyd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fedena_sdk.gemspec
+- lib/fedena_sdk.rb
+- lib/fedena_sdk/attendance.rb
+- lib/fedena_sdk/batch.rb
+- lib/fedena_sdk/client.rb
+- lib/fedena_sdk/course.rb
+- lib/fedena_sdk/employee_attendance.rb
+- lib/fedena_sdk/errors.rb
+- lib/fedena_sdk/model.rb
+- lib/fedena_sdk/news.rb
+- lib/fedena_sdk/school.rb
+- lib/fedena_sdk/user.rb
+- lib/fedena_sdk/version.rb
+homepage: https://github.com/tachyons/fedena-sdk-ruby
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Fedena Sdk
+test_files: []