gcal_mapper 0.1.1

data/lib/gcal_mapper/configuration.rb

@@ -0,0 +1,23 @@
+module GcalMapper
+  #
+  # Gem's configuration
+  #
+  class Configuration
+
+    attr_accessor :gid          # name of the field that contains google event id
+    attr_accessor :fields       # hash that contains all the field with their source config
+    attr_accessor :calendars    # array that contains all the calendar id to fetch
+    attr_accessor :file         # Auth file path
+    attr_accessor :client_email # Service account email
+    attr_accessor :user_email   # email of user to impersonat
+    attr_accessor :password     # passowrd for p12 key
+
+    # New configuration object
+    #
+    def initialize
+      @fields = {}
+      @calendars = []
+    end
+
+  end
+end

data/lib/gcal_mapper/errors.rb

@@ -0,0 +1,40 @@
+
+
+module GcalMapper
+  #
+  # An error which is raised when the authentification process fails
+  #
+  class AuthentificationError < StandardError
+  end
+
+  #
+  # An error which is raised when the yaml or p12 key does not contains what expected
+  #
+  class AuthFileError < StandardError
+  end
+
+  #
+  # An error which is raised when the http status code of the respose is not within 200..300
+  #
+  class ResponseStatusError < StandardError
+  end
+
+  #
+  # An exception which is raised when no calenards are accessible.
+  #
+  class CalendarAvailabilityError < StandardError
+  end
+
+  #
+  # An exception which is raised when specified calendar is not available.
+  #
+  class CalendarAccessibilityError < StandardError
+  end
+
+  #
+  # Error when there is error in user DSL
+  #
+  class DSLSyntaxError < StandardError
+  end
+
+end

data/lib/gcal_mapper/mapper.rb

@@ -0,0 +1,76 @@
+require 'gcal_mapper/mapper/dsl'
+require 'gcal_mapper/mapper/active_record'
+require 'gcal_mapper/mapper/simple'
+
+module GcalMapper
+  #
+  # Provide dsl en sync methods
+  #
+  module Mapper
+
+    # setter for class varaible base
+    #
+    # @return [Class] class name of the includer
+    def self.base=(base)
+      @@base = base
+    end
+
+    # reader for class varaible base
+    #
+    # @return [Class] class name of the includer
+    def self.base
+      @@base
+    end
+
+    # setter for config class attributes
+    #
+    # @param [Configuration] config configuration class
+    def self.config=(config)
+      @@config = config
+    end
+
+    # getter for config class attributes
+    #
+    # @return [Configuration] configuration class
+    def self.config
+      @@config
+    end
+
+    # setter for adapter class attributes
+    #
+    # @param [Configuration] config configuration class
+    def self.adapter=(adapter)
+      @@adapter = adapter
+    end
+
+    # getter for adapter class attributes
+    #
+    # @return [Configuration] configuration class
+    def self.adapter
+      @@adapter
+    end
+
+    #
+    # module to add class methods to the includer
+    #
+    module ClassMethods
+
+      # provide dsl function
+      #
+      # @param [Block] block contain dsl of th caller
+      def calendar(&block)
+        Mapper.config = GcalMapper::Configuration.new
+        dsl = DSL.new(Mapper.config)
+        dsl.instance_eval(&block)
+      end
+
+      # synchronize methods for the caller
+      #
+      def synchronize_calendar
+        Sync.sync(Mapper.config, Mapper.base)
+      end
+
+    end
+
+  end
+end

data/lib/gcal_mapper/mapper/active_record.rb

@@ -0,0 +1,74 @@
+require 'active_record'
+
+module GcalMapper
+  module Mapper
+    #
+    # module to include when active record is in use
+    #
+    module ActiveRecord
+
+      # execute when the file is included
+      #
+      # @param [Class] base class of the includer
+      def self.included(base)
+        base.extend(GcalMapper::Mapper::ClassMethods)
+        Mapper.base = base
+        Mapper.adapter = ActiveRecord.new(base)
+      end
+
+      #
+      # Adapter for ActiveRecord
+      #
+      class ActiveRecord
+
+        def initialize(base)
+          @base = base
+        end
+
+        # create and save object using attributes
+        #
+        # @param [Hash] attributes all the attributes to save in the new object
+        # return [Object] createrd object
+        def create!(attributes)
+          @base.create(attributes)
+        end
+
+        # update an object
+        #
+        # @param [Int] id id of the object in the DB
+        # @param [Hash] attributes hash containing the field to update
+        # @return [Object] updated object
+        def update!(id, attributes)
+          obj = @base.find(id)
+          obj.update_attributes!(attributes)
+        end
+
+        # delet an object
+        #
+        # @param [Int] id id of the object in the DB
+        # @return [Object] the destroyed object
+        def delete!(id)
+          obj = @base.find(id)
+          obj.destroy
+        end
+
+        # Find all models
+        #
+        # @return [Array] all the object from a calss
+        def find_all
+          @base.all
+        end
+
+        # find an object from a field and a value
+        #
+        # @param [String] field name of the field where to search
+        # @param [String] value the value to find
+        # @return [Object] the finded object or nil
+        def find_by(field, value)
+          @base.send('find_by_' + field, value)
+        end
+
+      end
+    end
+  end
+end

data/lib/gcal_mapper/mapper/dsl.rb

@@ -0,0 +1,57 @@
+module GcalMapper
+  module Mapper
+    #
+    # Provide DSL to configure gem
+    #
+    class DSL
+      VALID_FIELD_OPTIONS = [:source, :if_empty, :match, :default] # options available in DSL
+
+      # Intitialize config
+      #
+      def initialize(config)
+        @config = config
+      end
+
+      # Add new calendar id
+      #
+      # @param [string] id calendar id to add
+      def calendar (id)
+        @config.calendars.push(id)
+      end
+
+      # Add a new field
+      #
+      # @param [String] name DB field name
+      # @param [Hash] options contains source options used to fill the field
+      def field(name, options = {})
+        raise GcalMapper::DSLSyntaxError, 'Source option must be present' if !options.include?(:source)
+        raise GcalMapper::DSLSyntaxError, 'field option not available' if (options.keys != VALID_FIELD_OPTIONS & options.keys)
+
+        if options[:match]
+          raise GcalMapper::DSLSyntaxError, 'invalid regex' if options[:match].class != Regexp
+        end
+
+        @config.fields.merge!(name => options)
+      end
+
+      # Add authentification configuration
+      #
+      # @param [Hash] options contains the stuff to configure authetification
+      def configure(options = {})
+        raise GcalMapper::DSLSyntaxError, 'you must give a credential file' if options[:file].nil?
+        @config.file = options[:file]
+        @config.client_email = options[:client_email]
+        @config.user_email = options[:user_email]
+        @config.password = options[:password]
+      end
+
+      # Give the field in DB that is reserved to put event id given by google
+      #
+      # @param [String] name DB field name
+      def google_id(name)
+        @config.gid = name
+      end
+
+    end
+  end
+end

data/lib/gcal_mapper/mapper/simple.rb

@@ -0,0 +1,97 @@
+module GcalMapper
+  module Mapper
+    #
+    # module to include when no orm is used
+    #
+    module Simple
+
+      # execute when the file is included
+      #
+      # @param [Class] base class of the includer
+      def self.included(base)
+        base.extend(GcalMapper::Mapper::ClassMethods)
+        Mapper.base = base
+        Mapper.adapter = Simple.new(base)
+      end
+
+      #
+      # Adapter to use without an orm
+      #
+      class Simple
+        attr_reader :events # array of the synchronized events
+
+        # new object
+        #
+        # @param [class] klass class that need an adapter
+        def initialize(base)
+          @base = base
+          @events = []
+        end
+
+        # create and save object using attributes
+        #
+        # @param [Hash] attributes all the attributes to save in the new object
+        def create!(attributes)
+          obj = @base.new
+          obj.id = @events.count
+          attributes.each do |key, value|
+            obj.send(key+'=', value)
+          end
+
+          @events << obj
+        end
+
+        # update an object
+        #
+        # @param [Int] id id of the object in the DB
+        # @param [Hash] attributes hash containing the field to update
+        def update!(id, attributes)
+          obj = @events[id]
+          attributes.each do |key, value|
+            obj.send(key+'=', value)
+          end
+
+          @events << obj
+        end
+
+        # delet an object
+        #
+        # @param [Int] id id of the object in the DB
+        def delete!(id)
+          @events[id] = nil
+
+          @events.each_with_index do |item, index|
+            if item
+              if @events[index + 1]
+                item = @events[index + 1]
+                item.id =- 1
+              end
+            end
+          end
+
+          @events.delete(nil)
+        end
+
+        # Find all models
+        #
+        def find_all
+          @events
+        end
+
+        # find an object from a field and a value
+        #
+        # @param [String] field name of the field where to search
+        # @param [String] value the value to find
+        def find_by(field, value)
+          find_event = nil
+          @events.each do |event|
+            find_event = event if event.send(field) == value
+          end
+
+          find_event
+        end
+
+      end
+    end
+  end
+end

data/lib/gcal_mapper/railtie.rb

@@ -0,0 +1,8 @@
+module GcalMapper
+  #
+  # Extends Rails framework
+  #
+  class Railtie < Rails::Railtie
+
+  end
+end

data/lib/gcal_mapper/rest_request.rb

@@ -0,0 +1,73 @@
+require 'net/http'
+require 'json'
+
+module GcalMapper
+  #
+  # Make a REST get or post request
+  #
+  class RestRequest
+
+    attr_accessor :url        # Complete url for the request
+    attr_accessor :options    # Options for the REST request
+
+    # Initialize a new request
+    #
+    # @param [String] url the complete url of where to send the request
+    # @datarequest.rbparam [Hash] options contain all the options that can be included in REST request
+    def initialize (url, options = {})
+      @url = url
+      @options = options
+    end
+
+    # Set a proxy if the connection needs it
+    #
+    def proxy
+      http_proxy = ENV["http_proxy"]
+      URI.parse(http_proxy) rescue nil
+    end
+
+    # Execute REST request
+    #
+    # @return [Hash] a Json parsed hash that contains the body of the response.
+    def execute
+      options = {
+        :parameters => {}, :debug => false,
+        :http_timeout => 60, :method => :get,
+        :headers => {}, :redirect_count => 0,
+        :max_redirects => 10
+      }.merge(@options)
+      url = URI(@url)
+
+      if proxy
+        http = Net::HTTP::Proxy(proxy.host, proxy.port).new(url.host, url.port)
+      else
+        http = Net::HTTP.new(url.host, url.port)
+      end
+
+      if url.scheme == 'https'
+        http.use_ssl = true
+      end
+
+      http.open_timeout = http.read_timeout = options[:http_timeout]
+      http.set_debug_output $stderr if options[:debug]
+
+      request = case options[:method]
+      when :post
+        request = Net::HTTP::Post.new(url.request_uri)
+        request.set_form_data(options[:parameters])
+        request
+      else
+          request = Net::HTTP::Get.new(url.request_uri)
+      end
+
+      options[:headers].each { |key, value| request[key] = value }
+      response = http.request(request)
+      if !(200..300).include?(response.code.to_i)
+        raise GcalMapper::ResponseStatusError
+      end
+
+      JSON.parse(response.body)
+    end
+
+  end
+end