amplify_syndication 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2710bd59fa2d3c01b488bba30392f7bdf296741fbc698e8119c2a65c3ba5c33
+  data.tar.gz: d61cecb2245118e3db17c27c973c4c9a32f37d7f65f159bc48973da0c32edda4
+SHA512:
+  metadata.gz: 707bb585b4afc0d5476d874464d477f2632d51df1d7a3bd76c56a6a0f1c863fa71cdc4e9b8fd74e8740040527beafe9a2e1a84ed028fd0148911c826fb747562
+  data.tar.gz: 54e3c195ab9a89484722166f2a1146227c85d65e8c0e47ee4aa70c28b6c5f35edbfb20aaa58bcc31aadf9527f51f9d2be887e8ebb25bc33cfdf4489cec409de0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0
+
+API Client for use with Amplify Syndication API
+
+#### Includes API endpoints for
+- property 
+- media

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stephen Higgins
+
+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,184 @@
+# Amplify Syndication Gem
+
+## Overview
+
+`amplify_syndication` is a Ruby gem that provides a simple interface to interact with the Amplify Syndication API. It includes methods to manage properties, media, and other related resources in real estate applications.
+
+---
+
+## Features
+
+- Fetch and manage **Property** resources:
+  - Retrieve specific properties by `ListingKey`
+  - Query for properties with advanced filtering and sorting
+- Fetch and manage **Media** resources:
+  - Retrieve specific media by `MediaKey`
+  - Query for media associated with properties, offices, and members
+- Easy-to-use replication features for synchronizing data
+
+---
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```bash
+gem 'amplify_syndication'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install it manually:
+
+```bash
+gem install amplify_syndication
+```
+
+---
+
+## Configuration
+
+You need to configure the base URL and access token for the Amplify Syndication API. Add the following to your application’s initializer or a setup script:
+
+```bash
+AmplifySyndication.configure do |config|
+  config.base_url = "https://query.ampre.ca/odata"
+  config.access_token = "your_api_access_token_here"
+end
+```
+
+---
+
+## Usage
+
+### Initialize the API
+
+Create an instance of the API:
+
+```bash
+api = AmplifySyndication::API.new
+```
+
+---
+
+## Properties
+
+### Fetch Metadata
+
+Retrieve metadata for the API:
+
+```bash
+metadata = api.fetch_metadata
+puts metadata
+```
+
+### Replication: Initial Download
+
+Perform an initial download of properties for replication:
+
+```bash
+properties = api.perform_initial_download(batch_size: 100)
+puts "Downloaded #{properties.size} properties."
+```
+
+### Fetch Property by ListingKey
+
+Retrieve full details of a property by its ListingKey:
+
+```bash
+property = api.fetch_property_by_key("12345")
+puts property
+```
+
+### Fetch Filtered Properties
+
+Query for properties with advanced filtering:
+
+```bash
+filtered_properties = api.fetch_filtered_properties(
+  filter: "City eq 'Toronto' and ListPrice gt 500000",
+  select: "ListingKey,City,ListPrice",
+  orderby: "ListPrice desc",
+  top: 10
+)
+puts filtered_properties
+```
+
+### Fetch Property Count
+
+Get the total count of properties:
+
+```bash
+count = api.fetch_property_count
+puts "Total properties: #{count['@odata.count']}"
+```
+
+---
+
+## Media
+
+### Fetch Media by MediaKey
+
+Retrieve full details of a media record by its MediaKey:
+
+```bash
+media = api.fetch_media_by_key("61400d19-417e-4f43-b36e-efffb352a128")
+puts media
+```
+
+### Fetch Media by Resource
+
+Retrieve all media records associated with a specific resource:
+
+```bash
+property_media = api.fetch_media_by_resource("Property", "12345")
+puts property_media
+```
+
+### Fetch Recent Media
+
+Query for recently created or modified media:
+
+```bash
+recent_media = api.fetch_recent_media(
+  filter: "ResourceName eq 'Property'",
+  modification_date: "2023-12-01T00:00:00Z"
+)
+puts recent_media
+```
+
+---
+
+## Error Handling
+
+If an API call fails, the gem raises a StandardError with details of the HTTP response:
+
+```bash
+begin
+  property = api.fetch_property_by_key("invalid_key")
+rescue StandardError => e
+  puts "Error: #{e.message}"
+end
+```
+
+---
+
+## Contributing
+
+  1.  Fork the repository
+  2.  Create a feature branch (git checkout -b feature/new-feature)
+  3.  Commit your changes (git commit -m 'Add a new feature')
+  4.  Push to the branch (git push origin feature/new-feature)
+  5.  Create a Pull Request
+
+---
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gryphonandrook/amplify_syndication.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/amplify_syndication/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AmplifySyndication
+  VERSION = "0.1.0"
+end

data/lib/amplify_syndication.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "amplify_syndication/version"
+require_relative "amplify_syndication/configuration"
+require_relative "amplify_syndication/api"
+require_relative "amplify_syndication/client"
+
+module AmplifySyndication
+  class Error < StandardError; end
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/sig/amplify_syndication.rbs

@@ -0,0 +1,4 @@
+module AmplifySyndication
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: amplify_syndication
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Higgins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Provides a Ruby interface for interacting with the Amplify Syndication
+  API.
+email:
+- stephen@gryphonandrook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/amplify_syndication.rb
+- lib/amplify_syndication/version.rb
+- sig/amplify_syndication.rbs
+homepage: https://github.com/gryphonandrook/amplify_syndication
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gryphonandrook/amplify_syndication
+  source_code_uri: https://github.com/gryphonandrook/amplify_syndication
+  changelog_uri: https://github.com/gryphonandrook/amplify_syndication/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: An API client for Amplify Syndication services
+test_files: []