apis-is 1.0.0

data/examples/tv_example.rb

@@ -0,0 +1,37 @@
+require 'apis'
+
+# Possible Tv calls
+#
+# Apis.tv.ruv <- Fetch tv schedule for RUV
+# Apis.tv.ruvithrottir <- Fetch tv schedule for RUV Ithrottir
+# Apis.tv.stod2 <- Fetch tv schedule for Stod 2
+# Apis.tv.stod2sport <- Fetch tv schedule for Stod 2 Sport
+# Apis.tv.stod2sport2 <- Fetch tv schedule for Stod 2 Sport 2
+# Apis.tv.stod2gull <- Fetch tv schedule for Stod 2 Gull
+# Apis.tv.stod2bio <- Fetch tv schedule for Stod 2 Bio
+# Apis.tv.stod3 <- Fetch tv schedule for Stod 3
+# Apis.tv.skjar1 <- Fetch tv schedule for Skjar 1
+
+response = Apis.tv.ruv
+
+# prints out all results
+puts response[:results]
+
+# Result:
+# [
+#   {
+#     title: String,
+#     originalTitle: String,
+#     duration: String,
+#     description: String,
+#     shortDescription: String,
+#     live: Boolean,
+#     premier: Boolean,
+#     startTime: String,
+#     aspectRatio: String,
+#     series: {
+#       episode: String,
+#       series: String
+#     }
+#   }
+# ]

data/examples/weather_example.rb

@@ -0,0 +1,34 @@
+require 'apis'
+
+# Possible Weather calls
+#
+# Apis.weather.texts(types)
+# Apis.weather.observations(stations, lang = 'is', time = '1h', anytime = '0')
+# Apis.weather.forecasts(stations, lang = 'is')
+
+Apis.weather.observations([361])
+
+# prints out all results
+puts response[:results]
+
+# Result:
+# [
+#   {
+#     name:  String,
+#     atime: String,
+#     err: String,
+#     link: String,
+#     forecast: [
+#       {
+#         ftime: String,
+#         F: String,
+#         D: String,
+#         T: String,
+#         W: String,
+#         N: String,
+#         TD: String,
+#         R: String
+#       }
+#     ]
+#   }
+# ]

data/lib/apis.rb

@@ -0,0 +1,109 @@
+require 'apis/client'
+require 'apis/endpoints/tv'
+require 'apis/endpoints/bus'
+require 'apis/endpoints/cars'
+require 'apis/endpoints/cinema'
+require 'apis/endpoints/flights'
+require 'apis/endpoints/lottery'
+require 'apis/endpoints/weather'
+require 'apis/endpoints/currency'
+require 'apis/endpoints/companies'
+require 'apis/endpoints/earthquake'
+require 'apis/endpoints/cyclecounter'
+require 'apis/endpoints/particulates'
+
+# Ruby wrapper for the apis.is API
+module Apis
+  class << self
+    # API Client
+    #
+    # @return [Apis::Client] API wrapper
+    def client
+      Apis::Client.new
+    end
+
+    # API CycleCounter
+    #
+    # @return [Apis::CycleCounter] API wrapper
+    def cyclecounter
+      Apis::CycleCounter.new.cyclecounter
+    end
+
+    # API Earthquake
+    #
+    # @return [Apis::Earthquake] API wrapper
+    def earthquake
+      Apis::Earthquake.new.earthquake
+    end
+
+    # API Currency
+    #
+    # @return [Apis::Currency] API wrapper
+    def currency
+      Apis::Currency.new
+    end
+
+    # API Cinema
+    #
+    # @return [Apis::Cinema] API wrapper
+    def cinema
+      Apis::Cinema.new
+    end
+
+    # API Particulates
+    #
+    # @return [Apis::Particulates] API wrapper
+    def particulates
+      Apis::Particulates.new.particulates
+    end
+
+    # API Lottery
+    #
+    # @return [Apis::Lottery] API wrapper
+    def lottery
+      Apis::Lottery.new
+    end
+
+    # API Busses
+    #
+    # @return [Apis::Busses] API wrapper
+    def busses(params = [])
+      Apis::Busses.new.realtime(params)
+    end
+
+    # API Cars
+    #
+    # @return [Apis::Cars] API wrapper
+    def car(number)
+      Apis::Cars.new.car(number)
+    end
+
+    # API Companies
+    #
+    # @return [Apis::Companies] API wrapper
+    def companies
+      Apis::Companies.new
+    end
+
+    # API Tv
+    #
+    # @return [Apis::Tv] API wrapper
+    def tv
+      Apis::Tv.new
+    end
+
+    # API Flights
+    #
+    # @return [Apis::Flights] API wrapper
+    def flights
+      Apis::Flights.new
+    end
+
+    # API Weather
+    #
+    # @return [Apis::Weather] API wrapper
+    def weather
+      Apis::Weather.new
+    end
+  end
+end

data/lib/apis/client.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'apis/response/feed_parser'
+
+module Apis
+  # Client for the Apis API
+  #
+  # @see http://docs.apis.is/
+  class Client
+    # Apis.is url prefix
+    URL_PREFIX = 'http://apis.is'
+
+    # Apis.is Farafay Connection
+    #
+    # @return [Faraday::Connection]
+    def agent
+      Faraday.new(URL_PREFIX) do |fara|
+        fara.use Apis::Response::FeedParser
+        fara.adapter Faraday.default_adapter
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to the url prefix
+    # @return [Faraday::Response]
+    def get(path)
+      agent.get(path).body
+    end
+  end
+end

data/lib/apis/endpoints/bus.rb

@@ -0,0 +1,15 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch busses
+  class Busses
+    # Real-time location of busses.
+    # Results are only shown for active busses.
+    #
+    # @param busses [Array] List of requested busses (optional)
+    # @return [Faraday::Response] Api result.
+    def realtime(busses)
+      Apis.client.get("/bus/realtime?busses=#{busses.join(',')}")
+    end
+  end
+end

data/lib/apis/endpoints/cars.rb

@@ -0,0 +1,14 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch cars
+  class Cars
+    # Search the icelandic vehicle registry
+    #
+    # @param number [String] Car number (required)
+    # @return [Faraday::Response] Api result.
+    def car(number)
+      Apis.client.get("/car?number=#{number}")
+    end
+  end
+end

data/lib/apis/endpoints/cinema.rb

@@ -0,0 +1,22 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch cinema
+  class Cinema
+    # Get a list of showtimes in icelandic movie theaters;
+    # sort by movies
+    #
+    # @return [Faraday::Response] Api result.
+    def showtimes
+      Apis.client.get('/cinema')
+    end
+
+    # Get a list of showtimes in icelandic movie theaters;
+    # sort by theater
+    #
+    # @return [Faraday::Response] Api result.
+    def theaters
+      Apis.client.get('/cinema/theaters')
+    end
+  end
+end

data/lib/apis/endpoints/companies.rb

@@ -0,0 +1,38 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch companies
+  class Companies
+    # Search the icelandic company registry by name
+    #
+    # @param name [String] company name (required)
+    # @return [Faraday::Response] Api result.
+    def by_name(name)
+      Apis.client.get("/company?name=#{name}")
+    end
+
+    # Search the icelandic company registry by address
+    #
+    # @param address [String] company address (required)
+    # @return [Faraday::Response] Api result.
+    def by_address(address)
+      Apis.client.get("/company?address=#{address}")
+    end
+
+    # Search the icelandic company registry by social number
+    #
+    # @param socialnumber [String] company socialnumber (required)
+    # @return [Faraday::Response] Api result.
+    def by_sn(socialnumber)
+      Apis.client.get("/company?socialnumber=#{socialnumber}")
+    end
+
+    # Search the icelandic company registry by vsk number
+    #
+    # @param vsknr [String] company vsknumer (required)
+    # @return [Faraday::Response] Api result.
+    def by_vsknr(vsknr)
+      Apis.client.get("/company?vsknr=#{vsknr}")
+    end
+  end
+end

data/lib/apis/endpoints/currency.rb

@@ -0,0 +1,27 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch currency
+  class Currency
+    # Get currency data from Arion
+    #
+    # @return [Faraday::Response] Api result.
+    def arion
+      Apis.client.get('/currency/arion')
+    end
+
+    # Get currency data from m5
+    #
+    # @return [Faraday::Response] Api result.
+    def m5
+      Apis.client.get('/currency/m5')
+    end
+
+    # Get currency data from Landsbankinn
+    #
+    # @return [Faraday::Response] Api result.
+    def lb
+      Apis.client.get('/currency/lb')
+    end
+  end
+end

data/lib/apis/endpoints/cyclecounter.rb

@@ -0,0 +1,14 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch cyclecounter
+  class CycleCounter
+    # Get current status of bicycle counters in Iceland,
+    # currently only one located by Sudurlandsbraut in Reykjavik.
+    #
+    # @return [Faraday::Response] Api result.
+    def cyclecounter
+      Apis.client.get('/cyclecounter')
+    end
+  end
+end

data/lib/apis/endpoints/earthquake.rb

@@ -0,0 +1,13 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch earthquake
+  class Earthquake
+    # Get earthquake monitoring data for the last 48 hours.
+    #
+    # @return [Faraday::Response] Api result.
+    def earthquake
+      Apis.client.get('/earthquake/is')
+    end
+  end
+end

data/lib/apis/endpoints/flights.rb

@@ -0,0 +1,24 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch flights
+  class Flights
+    # Get a list of all international flights departure
+    # at Keflavik Airport today.
+    #
+    # @param lang [String] result language (optional)
+    # @return [Faraday::Response] Api result.
+    def departure(lang = 'is')
+      Apis.client.get("/flight?type=departures&language=#{lang}")
+    end
+
+    # Get a list of all international flights arriving
+    # at Keflavik Airport today.
+    #
+    # @param lang [String] result language (optional)
+    # @return [Faraday::Response] Api result.
+    def arrivals(lang = 'is')
+      Apis.client.get("/flight?type=arrivals&language=#{lang}")
+    end
+  end
+end

data/lib/apis/endpoints/lottery.rb

@@ -0,0 +1,27 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch lottery
+  class Lottery
+    # Get the most recent numbers for the icelandic lottery.
+    #
+    # @return [Faraday::Response] Api result.
+    def lotto
+      Apis.client.get('/lottery')
+    end
+
+    # Get the most recent numbers for the Vikingalotto.
+    #
+    # @return [Faraday::Response] Api result.
+    def vikingalotto
+      Apis.client.get('/lottery/vikingalotto')
+    end
+
+    # Get the most recent numbers for the Eurojackpot.
+    #
+    # @return [Faraday::Response] Api result.
+    def eurojackpot
+      Apis.client.get('/lottery/eurojackpot')
+    end
+  end
+end

data/lib/apis/endpoints/particulates.rb

@@ -0,0 +1,13 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch particulates
+  class Particulates
+    # Get current status of particulates in Reykjavik City
+    #
+    # @return [Faraday::Response] Api result.
+    def particulates
+      Apis.client.get('/particulates')
+    end
+  end
+end

data/lib/apis/endpoints/tv.rb

@@ -0,0 +1,69 @@
+require 'apis/client'
+
+module Apis
+  # Class to fetch tv
+  class Tv
+    # Get today's schedule from RUV
+    #
+    # @return [Faraday::Response] Api result.
+    def ruv
+      Apis.client.get('/tv/ruv')
+    end
+
+    # Get today's schedule from RUV ITHROTTIR
+    #
+    # @return [Faraday::Response] Api result.
+    def ruvithrottir
+      Apis.client.get('/tv/ruvithrottir')
+    end
+
+    # Get today's schedule from Stod 2
+    #
+    # @return [Faraday::Response] Api result.
+    def stod2
+      Apis.client.get('/tv/stod2')
+    end
+
+    # Get today's schedule from Stod 2 sport
+    #
+    # @return [Faraday::Response] Api result.
+    def stod2sport
+      Apis.client.get('/tv/stod2sport')
+    end
+
+    # Get today's schedule from Stod 2 sport 2
+    #
+    # @return [Faraday::Response] Api result.
+    def stod2sport2
+      Apis.client.get('/tv/stod2sport2')
+    end
+
+    # Get today's schedule from Stod 2 gull
+    #
+    # @return [Faraday::Response] Api result.
+    def stod2gull
+      Apis.client.get('/tv/stod2gull')
+    end
+
+    # Get today's schedule from Stod 2
+    #
+    # @return [Faraday::Response] Api result.
+    def stod2bio
+      Apis.client.get('/tv/stod2bio')
+    end
+
+    # Get today's schedule from Stod 3
+    #
+    # @return [Faraday::Response] Api result.
+    def stod3
+      Apis.client.get('/tv/stod3')
+    end
+
+    # Get today's schedule from Skjar 1
+    #
+    # @return [Faraday::Response] Api result.
+    def skjar1
+      Apis.client.get('/tv/skjar1')
+    end
+  end
+end